diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 41f5d8a93e..7aeaeab853 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -82818,12 +82818,40 @@ ] }, "nodes._types:NodeReloadResult": { - "oneOf": [ + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "reload_exception": { + "$ref": "#/components/schemas/_types:ErrorCause" + } + }, + "required": [ + "name" + ] + }, + "nodes.stats:ResponseBase": { + "allOf": [ { - "$ref": "#/components/schemas/nodes._types:Stats" + "$ref": "#/components/schemas/nodes._types:NodesResponseBase" }, { - "$ref": "#/components/schemas/nodes._types:NodeReloadError" + "type": "object", + "properties": { + "cluster_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "nodes": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/nodes._types:Stats" + } + } + }, + "required": [ + "nodes" + ] } ] }, @@ -83882,44 +83910,6 @@ } } }, - "nodes._types:NodeReloadError": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, - "reload_exception": { - "$ref": "#/components/schemas/_types:ErrorCause" - } - }, - "required": [ - "name" - ] - }, - "nodes.stats:ResponseBase": { - "allOf": [ - { - "$ref": "#/components/schemas/nodes._types:NodesResponseBase" - }, - { - "type": "object", - "properties": { - "cluster_name": { - "$ref": "#/components/schemas/_types:Name" - }, - "nodes": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/nodes._types:Stats" - } - } - }, - "required": [ - "nodes" - ] - } - ] - }, "nodes.usage:ResponseBase": { "allOf": [ { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 9d8f6ad45a..85cbcf5391 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -97296,1205 +97296,1040 @@ "specLocation": "ml/_types/TrainedModel.ts#L352-L355" }, { - "codegenNames": [ - "stats", - "error" - ], - "kind": "type_alias", - "name": { - "name": "NodeReloadResult", - "namespace": "nodes._types" - }, - "specLocation": "nodes/_types/NodeReloadResult.ts#L29-L30", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Stats", - "namespace": "nodes._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NodeReloadError", - "namespace": "nodes._types" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "Stats", - "namespace": "nodes._types" - }, - "properties": [ + "kind": "enum", + "members": [ { - "description": "Statistics about adaptive replica selection.", - "name": "adaptive_selection", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AdaptiveSelection", - "namespace": "nodes._types" - } - } - } + "name": "global" }, { - "description": "Statistics about the field data circuit breaker.", - "name": "breakers", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Breaker", - "namespace": "nodes._types" - } - } - } + "name": "exact" }, { - "description": "File system information, data path, free disk space, read/write stats.", - "name": "fs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FileSystem", - "namespace": "nodes._types" - } - } + "name": "exact_fuzzy" }, { - "description": "Network host for the node, based on the network host setting.", - "name": "host", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Host", - "namespace": "_types" - } - } + "name": "fuzzy" }, { - "description": "HTTP connection information.", - "name": "http", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Http", - "namespace": "nodes._types" - } - } + "name": "prefix" }, { - "description": "Statistics about ingest preprocessing.", - "name": "ingest", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Ingest", - "namespace": "nodes._types" - } - } + "name": "suffix" }, { - "description": "IP address and port for the node.", - "name": "ip", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Ip", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Ip", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } + "name": "contains" }, { - "description": "JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.", - "name": "jvm", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Jvm", - "namespace": "nodes._types" - } - } + "name": "lt" }, { - "description": "Human-readable identifier for the node.\nBased on the node name setting.", - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } + "name": "lte" }, { - "description": "Operating system stats, load average, mem, swap.", - "name": "os", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "OperatingSystem", - "namespace": "nodes._types" - } - } + "name": "gt" }, { - "description": "Process statistics, memory consumption, cpu usage, open file descriptors.", - "name": "process", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Process", - "namespace": "nodes._types" - } - } + "name": "gte" }, { - "description": "Roles assigned to the node.", - "name": "roles", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeRoles", - "namespace": "_types" - } - } - }, + "name": "always" + } + ], + "name": { + "name": "QueryRuleCriteriaType", + "namespace": "query_rules._types" + }, + "specLocation": "query_rules/_types/QueryRuleset.ts#L95-L108" + }, + { + "kind": "enum", + "members": [ { - "description": "Contains script statistics for the node.", - "name": "script", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Scripting", - "namespace": "nodes._types" - } - } + "name": "pinned" }, { - "name": "script_cache", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ScriptCache", - "namespace": "nodes._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ScriptCache", - "namespace": "nodes._types" - } - } - } - ], - "kind": "union_of" - } - } + "name": "exclude" + } + ], + "name": { + "name": "QueryRuleType", + "namespace": "query_rules._types" + }, + "specLocation": "query_rules/_types/QueryRuleset.ts#L60-L63" + }, + { + "kind": "enum", + "members": [ + { + "name": "min" }, { - "description": "Statistics about each thread pool, including current size, queue and rejected tasks.", - "name": "thread_pool", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ThreadCount", - "namespace": "nodes._types" - } - } - } + "name": "max" }, { - "name": "timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "sum" }, { - "description": "Transport statistics about sent and received bytes in cluster communication.", - "name": "transport", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Transport", - "namespace": "nodes._types" - } - } + "name": "avg" }, { - "description": "Host and port for the transport layer, used for internal communication between nodes in a cluster.", - "name": "transport_address", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TransportAddress", - "namespace": "_types" - } - } + "name": "value_count" + } + ], + "name": { + "name": "Metric", + "namespace": "rollup._types" + }, + "specLocation": "rollup/_types/Metric.ts#L22-L28" + }, + { + "kind": "enum", + "members": [ + { + "name": "started" }, { - "description": "Contains a list of attributes for the node.", - "name": "attributes", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "name": "indexing" }, { - "description": "Contains node discovery statistics for the node.", - "name": "discovery", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Discovery", - "namespace": "nodes._types" - } - } + "name": "stopping" }, { - "description": "Contains indexing pressure statistics for the node.", - "name": "indexing_pressure", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexingPressure", - "namespace": "nodes._types" - } - } + "name": "stopped" }, { - "description": "Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.", - "name": "indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardStats", - "namespace": "indices.stats" - } - } + "name": "aborting" } ], - "specLocation": "nodes/_types/Stats.ts#L30-L114" - }, - { - "kind": "interface", "name": { - "name": "AdaptiveSelection", - "namespace": "nodes._types" + "name": "IndexingJobState", + "namespace": "rollup.get_jobs" }, - "properties": [ - { - "description": "The exponentially weighted moving average queue size of search requests on the keyed node.", - "name": "avg_queue_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, + "specLocation": "rollup/get_jobs/types.ts#L77-L83" + }, + { + "kind": "enum", + "members": [ { - "description": "The exponentially weighted moving average response time of search requests on the keyed node.", - "name": "avg_response_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "codegenName": "PageView", + "name": "page_view" }, { - "description": "The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.", - "name": "avg_response_time_ns", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "codegenName": "Search", + "name": "search" }, { - "description": "The exponentially weighted moving average service time of search requests on the keyed node.", - "name": "avg_service_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, + "codegenName": "SearchClick", + "name": "search_click" + } + ], + "name": { + "name": "EventType", + "namespace": "search_application._types" + }, + "specLocation": "search_application/_types/AnalyticsEvent.ts#L22-L26" + }, + { + "kind": "enum", + "members": [ { - "description": "The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.", - "name": "avg_service_time_ns", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "cluster" }, { - "description": "The number of outstanding search requests to the keyed node from the node these stats are for.", - "name": "outgoing_searches", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "indices" }, { - "description": "The rank of this node; used for shard selection when routing search requests.", - "name": "rank", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "shards" } ], - "specLocation": "nodes/_types/Stats.ts#L439-L468" + "name": { + "name": "StatsLevel", + "namespace": "searchable_snapshots._types" + }, + "specLocation": "searchable_snapshots/_types/stats.ts#L20-L24" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "rest" + }, + { + "name": "cross_cluster" + } + ], "name": { - "name": "Breaker", - "namespace": "nodes._types" + "name": "ApiKeyType", + "namespace": "security._types" }, - "properties": [ + "specLocation": "security/_types/ApiKey.ts#L115-L118" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ { - "description": "Estimated memory used for the operation.", - "name": "estimated_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "all" }, { - "description": "Estimated memory used, in bytes, for the operation.", - "name": "estimated_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "cancel_task" }, { - "description": "Memory limit for the circuit breaker.", - "name": "limit_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "manage" }, { - "description": "Memory limit, in bytes, for the circuit breaker.", - "name": "limit_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "manage_api_key" }, { - "description": "A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.", - "name": "overhead", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } + "name": "manage_behavioral_analytics" }, { - "description": "Total number of times the circuit breaker has been triggered and prevented an out of memory error.", - "name": "tripped", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } + "name": "manage_enrich" + }, + { + "name": "manage_index_templates" + }, + { + "name": "manage_inference" + }, + { + "name": "manage_ingest_pipelines" + }, + { + "name": "manage_logstash_pipelines" + }, + { + "name": "manage_ml" + }, + { + "name": "manage_own_api_key" + }, + { + "name": "manage_pipeline" + }, + { + "name": "manage_search_application" + }, + { + "name": "manage_search_query_rules" + }, + { + "name": "manage_search_synonyms" + }, + { + "name": "manage_security" + }, + { + "name": "manage_transform" + }, + { + "name": "monitor" + }, + { + "name": "monitor_enrich" + }, + { + "name": "monitor_inference" + }, + { + "name": "monitor_ml" + }, + { + "name": "monitor_transform" + }, + { + "name": "none" + }, + { + "name": "post_behavioral_analytics_event" + }, + { + "name": "read_pipeline" + }, + { + "name": "read_security" } ], - "specLocation": "nodes/_types/Stats.ts#L470-L495" + "name": { + "name": "ClusterPrivilege", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L42-L199" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "description": "In this type of grant, you must supply the user ID and password for which you want to create the API key.", + "name": "password" + }, + { + "description": "In this type of grant, you must supply an access token that was created by the Elasticsearch token service.\nIf you are activating a user profile, you can alternatively supply a JWT (either a JWT `access_token` or a JWT `id_token`).", + "name": "access_token" + } + ], "name": { - "name": "FileSystem", - "namespace": "nodes._types" + "name": "GrantType", + "namespace": "security._types" }, - "properties": [ + "specLocation": "security/_types/GrantType.ts#L20-L30" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ { - "description": "List of all file stores.", - "name": "data", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataPathStats", - "namespace": "nodes._types" - } - } - } + "name": "all" }, { - "description": "Last time the file stores statistics were refreshed.\nRecorded in milliseconds since the Unix Epoch.", - "name": "timestamp", - "required": false, - "type": { + "name": "auto_configure" + }, + { + "name": "create" + }, + { + "name": "create_doc" + }, + { + "name": "create_index" + }, + { + "name": "delete" + }, + { + "name": "delete_index" + }, + { + "name": "index" + }, + { + "name": "maintenance" + }, + { + "name": "manage" + }, + { + "name": "manage_data_stream_lifecycle" + }, + { + "name": "monitor" + }, + { + "name": "none" + }, + { + "name": "read" + }, + { + "name": "view_index_metadata" + }, + { + "name": "write" + } + ], + "name": { + "name": "IndexPrivilege", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L387-L429" + }, + { + "codegenNames": [ + "json_text", + "query", + "template" + ], + "description": "While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts.", + "kind": "type_alias", + "name": { + "name": "IndicesPrivilegesQuery", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L342-L350", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "description": "Contains statistics for all file stores of the node.", - "name": "total", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "FileSystemTotal", - "namespace": "nodes._types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RoleTemplateQuery", + "namespace": "security._types" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "RoleTemplateQuery", + "namespace": "security._types" + }, + "properties": [ { - "description": "Contains I/O statistics for the node.", - "name": "io_stats", + "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.", + "extDocId": "templating-role-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query", + "name": "template", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IoStats", - "namespace": "nodes._types" + "name": "RoleTemplateScript", + "namespace": "security._types" } } } ], - "specLocation": "nodes/_types/Stats.ts#L769-L787" + "specLocation": "security/_types/Privileges.ts#L352-L362" }, { "kind": "interface", "name": { - "name": "DataPathStats", - "namespace": "nodes._types" + "name": "RoleTemplateScript", + "namespace": "security._types" }, "properties": [ { - "description": "Total amount of disk space available to this Java virtual machine on this file store.", - "name": "available", + "name": "source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RoleTemplateInlineQuery", + "namespace": "security._types" } } }, { - "description": "Total number of bytes available to this Java virtual machine on this file store.", - "name": "available_in_bytes", + "description": "The `id` for a stored script.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "name": "disk_queue", + "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", + "name": "params", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "name": "disk_reads", + "description": "Specifies the language the script is written in.", + "name": "lang", "required": false, + "serverDefault": "painless", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ScriptLanguage", "namespace": "_types" } } }, { - "name": "disk_read_size", + "name": "options", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "disk_read_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "disk_writes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, - { - "name": "disk_write_size", - "required": false, - "type": { + } + ], + "shortcutProperty": "source", + "specLocation": "security/_types/Privileges.ts#L364-L382" + }, + { + "codegenNames": [ + "query_string", + "query_object" + ], + "kind": "type_alias", + "name": { + "name": "RoleTemplateInlineQuery", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L384-L385", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - } - }, - { - "name": "disk_write_size_in_bytes", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [], + "name": { + "name": "RemoteClusterPrivilege", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L201-L214" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ { - "description": "Total amount of unallocated disk space in the file store.", - "name": "free", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "search_application_query" + } + ], + "name": { + "name": "RestrictionWorkflow", + "namespace": "security._types" + }, + "specLocation": "security/_types/RoleDescriptor.ts#L143-L146" + }, + { + "kind": "enum", + "members": [ + { + "name": "string" }, { - "description": "Total number of unallocated bytes in the file store.", - "name": "free_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "json" + } + ], + "name": { + "name": "TemplateFormat", + "namespace": "security._types" + }, + "specLocation": "security/_types/RoleTemplate.ts#L22-L25" + }, + { + "kind": "type_alias", + "name": { + "name": "UserProfileId", + "namespace": "security._types" + }, + "specLocation": "security/_types/UserProfile.ts#L25-L25", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ + { + "description": "This grant type implements the Resource Owner Password Credentials Grant of OAuth2.\nIn this grant, a trusted client exchanges the end user's credentials for an access token and (possibly) a refresh token.\nThe request needs to be made by an authenticated user but happens on behalf of another authenticated user (the one whose credentials are passed as request parameters).\nThis grant type is not suitable or designed for the self-service user creation of tokens.", + "name": "password" }, { - "description": "Mount point of the file store (for example: `/dev/sda2`).", - "name": "mount", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "This grant type implements the Client Credentials Grant of OAuth2.\nIt is geared for machine to machine communication and is not suitable or designed for the self-service user creation of tokens.\nIt generates only access tokens that cannot be refreshed.\nThe premise is that the entity that uses `client_credentials` has constant access to a set of (client, not end-user) credentials and can authenticate itself at will.", + "name": "client_credentials" }, { - "description": "Path to the file store.", - "name": "path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "This grant type is supported internally and implements SPNEGO based Kerberos support.\nThe `_kerberos` grant type may change from version to version.", + "name": "_kerberos" }, { - "description": "Total size of the file store.", - "name": "total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "This grant type implements the Refresh Token Grant of OAuth2.\nIn this grant a user exchanges a previously issued refresh token for a new access token and a new refresh token.", + "name": "refresh_token" + } + ], + "name": { + "name": "AccessTokenGrantType", + "namespace": "security.get_token" + }, + "specLocation": "security/get_token/types.ts#L23-L48" + }, + { + "kind": "enum", + "members": [ + { + "name": "access_token" }, { - "description": "Total size of the file store in bytes.", - "name": "total_in_bytes", - "required": false, + "name": "password" + } + ], + "name": { + "name": "ApiKeyGrantType", + "namespace": "security.grant_api_key" + }, + "specLocation": "security/grant_api_key/types.ts#L47-L50" + }, + { + "kind": "type_alias", + "name": { + "name": "ApplicationsPrivileges", + "namespace": "security.has_privileges" + }, + "specLocation": "security/has_privileges/types.ts#L47-L47", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "Name", + "namespace": "_types" } }, - { - "description": "Type of the file store (ex: ext4).", - "name": "type", - "required": false, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "ResourcePrivileges", + "namespace": "security.has_privileges" } } - ], - "specLocation": "nodes/_types/Stats.ts#L586-L630" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "FileSystemTotal", - "namespace": "nodes._types" + "name": "ResourcePrivileges", + "namespace": "security.has_privileges" }, - "properties": [ - { - "description": "Total disk space available to this Java virtual machine on all file stores.\nDepending on OS or process level restrictions, this might appear less than `free`.\nThis is the actual amount of free disk space the Elasticsearch node can utilise.", - "name": "available", - "required": false, + "specLocation": "security/has_privileges/types.ts#L48-L48", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "Name", + "namespace": "_types" } }, - { - "description": "Total number of bytes available to this Java virtual machine on all file stores.\nDepending on OS or process level restrictions, this might appear less than `free_in_bytes`.\nThis is the actual amount of free disk space the Elasticsearch node can utilise.", - "name": "available_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total unallocated disk space in all file stores.", - "name": "free", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Total number of unallocated bytes in all file stores.", - "name": "free_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total size of all file stores.", - "name": "total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Total size of all file stores in bytes.", - "name": "total_in_bytes", - "required": false, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "Privileges", + "namespace": "security.has_privileges" } } - ], - "specLocation": "nodes/_types/Stats.ts#L828-L857" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "IoStats", - "namespace": "nodes._types" + "name": "Privileges", + "namespace": "security.has_privileges" }, - "properties": [ - { - "description": "Array of disk metrics for each device that is backing an Elasticsearch data path.\nThese disk metrics are probed periodically and averages between the last probe and the current probe are computed.", - "name": "devices", - "required": false, + "specLocation": "security/has_privileges/types.ts#L49-L49", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IoStatDevice", - "namespace": "nodes._types" - } - } + "name": "string", + "namespace": "_builtins" } }, - { - "description": "The sum of the disk metrics for all devices that back an Elasticsearch data path.", - "name": "total", - "required": false, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "IoStatDevice", - "namespace": "nodes._types" - } + "name": "boolean", + "namespace": "_builtins" } } - ], - "specLocation": "nodes/_types/Stats.ts#L789-L799" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "IoStatDevice", - "namespace": "nodes._types" + "name": "ApiKeyAggregate", + "namespace": "security.query_api_keys" }, - "properties": [ - { - "description": "The Linux device name.", - "name": "device_name", - "required": false, - "type": { + "specLocation": "security/query_api_keys/types.ts#L122-L139", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CardinalityAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The total number of read and write operations for the device completed since starting Elasticsearch.", - "name": "operations", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ValueCountAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The total number of kilobytes read for the device since starting Elasticsearch.", - "name": "read_kilobytes", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "StringTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The total number of read operations for the device completed since starting Elasticsearch.", - "name": "read_operations", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "LongTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The total number of kilobytes written for the device since starting Elasticsearch.", - "name": "write_kilobytes", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DoubleTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The total number of write operations for the device completed since starting Elasticsearch.", - "name": "write_operations", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "UnmappedTermsAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L801-L826" - }, - { - "kind": "interface", - "name": { - "name": "Http", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Current number of open HTTP connections for the node.", - "name": "current_open", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "MultiTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Total number of HTTP connections opened for the node.", - "name": "total_opened", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "MissingAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Information on current and recently-closed HTTP client connections.\nClients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here.", - "name": "clients", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Client", - "namespace": "nodes._types" - } + }, + { + "kind": "instance_of", + "type": { + "name": "FilterAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L669-L688" - }, - { - "kind": "interface", - "name": { - "name": "Client", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Unique ID for the HTTP client.", - "name": "id", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "FiltersAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Reported agent for the HTTP client.\nIf unavailable, this property is not included in the response.", - "name": "agent", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RangeAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Local address for the HTTP connection.", - "name": "local_address", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateRangeAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "CompositeAggregate", + "namespace": "_types.aggregations" } } + ], + "kind": "union_of" + }, + "variants": { + "kind": "external_tag", + "nonExhaustive": true + } + }, + { + "kind": "enum", + "members": [ + { + "name": "restart" }, { - "description": "Remote address for the HTTP connection.", - "name": "remote_address", - "required": false, - "type": { + "name": "remove" + }, + { + "name": "replace" + } + ], + "name": { + "name": "Type", + "namespace": "shutdown._types" + }, + "specLocation": "shutdown/_types/types.ts#L20-L24" + }, + { + "kind": "enum", + "members": [ + { + "name": "not_started" + }, + { + "name": "in_progress" + }, + { + "name": "stalled" + }, + { + "name": "complete" + } + ], + "name": { + "name": "ShutdownStatus", + "namespace": "shutdown.get_node" + }, + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L45-L50" + }, + { + "kind": "enum", + "members": [ + { + "name": "remove" + }, + { + "name": "restart" + } + ], + "name": { + "name": "ShutdownType", + "namespace": "shutdown.get_node" + }, + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L40-L43" + }, + { + "kind": "type_alias", + "name": { + "name": "Repository", + "namespace": "snapshot._types" + }, + "specLocation": "snapshot/_types/SnapshotRepository.ts#L24-L34", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AzureRepository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GcsRepository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "S3Repository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SharedFileSystemRepository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ReadOnlyUrlRepository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SourceOnlyRepository", + "namespace": "snapshot._types" } } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" + } + }, + { + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", + "name": { + "name": "AzureRepository", + "namespace": "snapshot._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "azure" + } }, { - "description": "The URI of the client’s most recent request.", - "name": "last_uri", - "required": false, + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AzureRepositorySettings", + "namespace": "snapshot._types" } } - }, + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L40-L43" + }, + { + "kind": "interface", + "name": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + }, + "properties": [ { - "description": "Time at which the client opened the connection.", - "name": "opened_time_millis", + "name": "uuid", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Uuid", "namespace": "_types" } } - }, + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L36-L38" + }, + { + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", + "name": { + "name": "AzureRepositorySettings", + "namespace": "snapshot._types" + }, + "properties": [ { - "description": "Time at which the client closed the connection if the connection is closed.", - "name": "closed_time_millis", + "name": "client", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Time of the most recent request from this client.", - "name": "last_request_time_millis", + "name": "container", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Number of requests from this client.", - "name": "request_count", + "name": "base_path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Cumulative size in bytes of all requests from this client.", - "name": "request_size_bytes", + "name": "readonly", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.", - "name": "x_opaque_id", + "name": "location_mode", "required": false, "type": { "kind": "instance_of", @@ -98505,514 +98340,475 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L720-L767" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L77-L83" }, { "kind": "interface", "name": { - "name": "Ingest", - "namespace": "nodes._types" + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" }, "properties": [ { - "description": "Contains statistics about ingest pipelines for the node.", - "name": "pipelines", + "name": "chunk_size", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IngestStats", - "namespace": "nodes._types" - } + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" } } }, { - "description": "Contains statistics about ingest operations for the node.", - "name": "total", + "name": "compress", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IngestTotal", - "namespace": "nodes._types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "max_restore_bytes_per_sec", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "name": "max_snapshot_bytes_per_sec", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" } } } ], - "specLocation": "nodes/_types/Stats.ts#L345-L354" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L70-L75" }, { + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } + }, "kind": "interface", "name": { - "name": "IngestStats", - "namespace": "nodes._types" + "name": "GcsRepository", + "namespace": "snapshot._types" }, "properties": [ { - "description": "Total number of documents ingested during the lifetime of this node.", - "name": "count", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "kind": "literal_value", + "value": "gcs" } }, { - "description": "Total number of documents currently being ingested.", - "name": "current", + "name": "settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "GcsRepositorySettings", + "namespace": "snapshot._types" } } - }, + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L45-L48" + }, + { + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", + "name": { + "name": "GcsRepositorySettings", + "namespace": "snapshot._types" + }, + "properties": [ { - "description": "Total number of failed ingest operations during the lifetime of this node.", - "name": "failed", + "name": "bucket", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Total number of ingest processors.", - "name": "processors", - "required": true, + "name": "client", + "required": false, "type": { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "KeyedProcessor", - "namespace": "nodes._types" - } - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", - "name": "time_in_millis", - "required": true, + "name": "base_path", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.15.0", - "stability": "stable" - } - }, - "description": "Total number of bytes of all documents ingested by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.", - "name": "ingested_as_first_pipeline_in_bytes", - "required": true, + "name": "readonly", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.15.0", - "stability": "stable" - } - }, - "description": "Total number of bytes of all documents produced by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.\nIn situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.", - "name": "produced_as_first_pipeline_in_bytes", - "required": true, + "name": "application_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "nodes/_types/Stats.ts#L356-L394" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L85-L91" }, { + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } + }, "kind": "interface", "name": { - "name": "KeyedProcessor", - "namespace": "nodes._types" + "name": "S3Repository", + "namespace": "snapshot._types" }, "properties": [ { - "name": "stats", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Processor", - "namespace": "nodes._types" - } + "kind": "literal_value", + "value": "s3" } }, { - "name": "type", - "required": false, + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "S3RepositorySettings", + "namespace": "snapshot._types" } } } ], - "specLocation": "nodes/_types/Stats.ts#L415-L418" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L50-L53" }, { + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, "kind": "interface", "name": { - "name": "Processor", - "namespace": "nodes._types" + "name": "S3RepositorySettings", + "namespace": "snapshot._types" }, "properties": [ { - "description": "Number of documents transformed by the processor.", - "name": "count", - "required": false, + "name": "bucket", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Number of documents currently being transformed by the processor.", - "name": "current", + "name": "client", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Number of failed operations for the processor.", - "name": "failed", + "name": "base_path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Time, in milliseconds, spent by the processor transforming documents.", - "name": "time_in_millis", + "name": "readonly", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "nodes/_types/Stats.ts#L420-L437" - }, - { - "kind": "interface", - "name": { - "name": "IngestTotal", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "description": "Total number of documents ingested during the lifetime of this node.", - "name": "count", - "required": true, + "name": "server_side_encryption", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Total number of documents currently being ingested.", - "name": "current", - "required": true, + "name": "buffer_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ByteSize", "namespace": "_types" } } }, { - "description": "Total number of failed ingest operations during the lifetime of this node.", - "name": "failed", - "required": true, + "name": "canned_acl", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", - "name": "time_in_millis", - "required": true, + "name": "storage_class", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "nodes/_types/Stats.ts#L396-L413" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L93-L102" }, { + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } + }, "kind": "interface", "name": { - "name": "Jvm", - "namespace": "nodes._types" + "name": "SharedFileSystemRepository", + "namespace": "snapshot._types" }, "properties": [ { - "description": "Contains statistics about JVM buffer pools for the node.", - "name": "buffer_pools", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "NodeBufferPool", - "namespace": "nodes._types" - } - } - } - }, - { - "description": "Contains statistics about classes loaded by JVM for the node.", - "name": "classes", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "JvmClasses", - "namespace": "nodes._types" - } + "kind": "literal_value", + "value": "fs" } }, { - "description": "Contains statistics about JVM garbage collectors for the node.", - "name": "gc", - "required": false, + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GarbageCollector", - "namespace": "nodes._types" + "name": "SharedFileSystemRepositorySettings", + "namespace": "snapshot._types" } } - }, + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L55-L58" + }, + { + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", + "name": { + "name": "SharedFileSystemRepositorySettings", + "namespace": "snapshot._types" + }, + "properties": [ { - "description": "Contains JVM memory usage statistics for the node.", - "name": "mem", - "required": false, + "name": "location", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "JvmMemoryStats", - "namespace": "nodes._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about JVM thread usage for the node.", - "name": "threads", + "name": "max_number_of_snapshots", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JvmThreads", - "namespace": "nodes._types" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Last time JVM statistics were refreshed.", - "name": "timestamp", + "name": "readonly", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L104-L108" + }, + { + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", + "name": { + "name": "ReadOnlyUrlRepository", + "namespace": "snapshot._types" + }, + "properties": [ { - "description": "Human-readable JVM uptime.\nOnly returned if the `human` query parameter is `true`.", - "name": "uptime", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "url" } }, { - "description": "JVM uptime in milliseconds.", - "name": "uptime_in_millis", - "required": false, + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ReadOnlyUrlRepositorySettings", + "namespace": "snapshot._types" } } } ], - "specLocation": "nodes/_types/Stats.ts#L882-L916" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L60-L63" }, { + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, "kind": "interface", "name": { - "name": "NodeBufferPool", - "namespace": "nodes._types" + "name": "ReadOnlyUrlRepositorySettings", + "namespace": "snapshot._types" }, "properties": [ { - "description": "Number of buffer pools.", - "name": "count", + "name": "http_max_retries", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "description": "Total capacity of buffer pools.", - "name": "total_capacity", + "name": "http_socket_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "description": "Total capacity of buffer pools in bytes.", - "name": "total_capacity_in_bytes", + "name": "max_number_of_snapshots", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "description": "Size of buffer pools.", - "name": "used", - "required": false, + "name": "url", + "required": true, "type": { "kind": "instance_of", "type": { @@ -99020,80 +98816,282 @@ "namespace": "_builtins" } } + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L110-L115" + }, + { + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", + "name": { + "name": "SourceOnlyRepository", + "namespace": "snapshot._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "source" + } }, { - "description": "Size of buffer pools in bytes.", - "name": "used_in_bytes", - "required": false, + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "SourceOnlyRepositorySettings", + "namespace": "snapshot._types" } } } ], - "specLocation": "nodes/_types/Stats.ts#L859-L880" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L65-L68" }, { + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, "kind": "interface", "name": { - "name": "JvmClasses", - "namespace": "nodes._types" + "name": "SourceOnlyRepositorySettings", + "namespace": "snapshot._types" }, "properties": [ { - "description": "Number of classes currently loaded by JVM.", - "name": "current_loaded_count", + "name": "delegate_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Total number of classes loaded since the JVM started.", - "name": "total_loaded_count", + "name": "max_number_of_snapshots", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "description": "Total number of classes unloaded since the JVM started.", - "name": "total_unloaded_count", + "aliases": [ + "readonly" + ], + "name": "read_only", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "nodes/_types/Stats.ts#L979-L992" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L117-L124" }, { - "kind": "interface", - "name": { - "name": "GarbageCollector", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Contains statistics about JVM garbage collectors for the node.", - "name": "collectors", - "required": false, - "type": { + "kind": "enum", + "members": [ + { + "description": "Number of shards in the snapshot that were successfully stored in the repository.", + "name": "DONE" + }, + { + "description": "Number of shards in the snapshot that were not successfully stored in the repository.", + "name": "FAILURE" + }, + { + "description": "Number of shards in the snapshot that are in the finalizing stage of being stored in the repository.", + "name": "FINALIZE" + }, + { + "description": "Number of shards in the snapshot that are in the initializing stage of being stored in the repository.", + "name": "INIT" + }, + { + "description": "Number of shards in the snapshot that are in the started stage of being stored in the repository.", + "name": "STARTED" + } + ], + "name": { + "name": "ShardsStatsStage", + "namespace": "snapshot._types" + }, + "specLocation": "snapshot/_types/SnapshotShardsStatsStage.ts#L20-L31" + }, + { + "kind": "enum", + "members": [ + { + "name": "start_time" + }, + { + "name": "duration" + }, + { + "name": "name" + }, + { + "name": "index_count" + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "repository" + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "shard_count" + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "failed_shard_count" + } + ], + "name": { + "name": "SnapshotSort", + "namespace": "snapshot._types" + }, + "specLocation": "snapshot/_types/SnapshotInfo.ts#L73-L93" + }, + { + "kind": "type_alias", + "name": { + "name": "Row", + "namespace": "sql" + }, + "specLocation": "sql/types.ts#L28-L28", + "type": { + "kind": "array_of", + "value": { + "kind": "user_defined_value" + } + } + }, + { + "kind": "enum", + "members": [ + { + "name": "csv" + }, + { + "name": "json" + }, + { + "name": "tsv" + }, + { + "name": "txt" + }, + { + "name": "yaml" + }, + { + "name": "cbor" + }, + { + "name": "smile" + } + ], + "name": { + "name": "SqlFormat", + "namespace": "sql.query" + }, + "specLocation": "sql/query/QuerySqlRequest.ts#L148-L156" + }, + { + "kind": "type_alias", + "name": { + "name": "SynonymString", + "namespace": "synonyms._types" + }, + "specLocation": "synonyms/_types/SynonymRule.ts#L23-L23", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ + { + "description": "Group tasks by node ID.", + "name": "nodes" + }, + { + "description": "Group tasks by parent task ID.", + "name": "parents" + }, + { + "description": "Do not group tasks.", + "name": "none" + } + ], + "name": { + "name": "GroupBy", + "namespace": "tasks._types" + }, + "specLocation": "tasks/_types/GroupBy.ts#L20-L27" + }, + { + "codegenNames": [ + "flat", + "grouped" + ], + "kind": "type_alias", + "name": { + "name": "TaskInfos", + "namespace": "tasks._types" + }, + "specLocation": "tasks/_types/TaskListResponseBase.ts#L40-L43", + "type": { + "items": [ + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TaskInfo", + "namespace": "tasks._types" + } + } + }, + { "key": { "kind": "instance_of", "type": { @@ -99106,96 +99104,92 @@ "value": { "kind": "instance_of", "type": { - "name": "GarbageCollectorTotal", - "namespace": "nodes._types" + "name": "ParentTaskInfo", + "namespace": "tasks._types" } } } - } - ], - "specLocation": "nodes/_types/Stats.ts#L994-L999" + ], + "kind": "union_of" + } }, { "kind": "interface", "name": { - "name": "GarbageCollectorTotal", - "namespace": "nodes._types" + "name": "TaskInfo", + "namespace": "tasks._types" }, "properties": [ { - "description": "Total number of JVM garbage collectors that collect objects.", - "name": "collection_count", - "required": false, + "name": "action", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Total time spent by JVM collecting objects.", - "name": "collection_time", + "name": "cancelled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "Total time, in milliseconds, spent by JVM collecting objects.", - "name": "collection_time_in_millis", - "required": false, + "name": "cancellable", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "nodes/_types/Stats.ts#L1001-L1014" - }, - { - "kind": "interface", - "name": { - "name": "JvmMemoryStats", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "description": "Memory, in bytes, currently in use by the heap.", - "name": "heap_used_in_bytes", + "description": "Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Percentage of memory currently in use by the heap.", - "name": "heap_used_percent", - "required": false, + "name": "headers", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "Amount of memory, in bytes, available for use by the heap.", - "name": "heap_committed_in_bytes", - "required": false, + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { @@ -99205,1572 +99199,1194 @@ } }, { - "description": "Maximum amount of memory, in bytes, available for use by the heap.", - "name": "heap_max_in_bytes", - "required": false, + "name": "node", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "NodeId", "namespace": "_types" } } }, { - "description": "Non-heap memory used, in bytes.", - "name": "non_heap_used_in_bytes", + "name": "running_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } }, { - "description": "Amount of non-heap memory available, in bytes.", - "name": "non_heap_committed_in_bytes", - "required": false, + "name": "running_time_in_nanos", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitNanos", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "long", + "name": "DurationValue", "namespace": "_types" } } }, { - "description": "Contains statistics about heap memory usage for the node.", - "name": "pools", - "required": false, + "name": "start_time_in_millis", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Pool", - "namespace": "nodes._types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } } - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L918-L947" - }, - { - "kind": "interface", - "name": { - "name": "Pool", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Memory, in bytes, used by the heap.", - "name": "used_in_bytes", - "required": false, - "type": { + ], "kind": "instance_of", "type": { - "name": "long", + "name": "EpochTime", "namespace": "_types" } } }, { - "description": "Maximum amount of memory, in bytes, available for use by the heap.", - "name": "max_in_bytes", + "description": "The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.", + "name": "status", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "kind": "user_defined_value" } }, { - "description": "Largest amount of memory, in bytes, historically used by the heap.", - "name": "peak_used_in_bytes", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Largest amount of memory, in bytes, historically used by the heap.", - "name": "peak_max_in_bytes", + "name": "parent_task_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "TaskId", "namespace": "_types" } } } ], - "specLocation": "nodes/_types/Stats.ts#L949-L966" + "specLocation": "tasks/_types/TaskInfo.ts#L32-L58" }, { + "inherits": { + "type": { + "name": "TaskInfo", + "namespace": "tasks._types" + } + }, "kind": "interface", "name": { - "name": "JvmThreads", - "namespace": "nodes._types" + "name": "ParentTaskInfo", + "namespace": "tasks._types" }, "properties": [ { - "description": "Number of active threads in use by JVM.", - "name": "count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Highest number of threads used by JVM.", - "name": "peak_count", + "name": "children", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TaskInfo", + "namespace": "tasks._types" + } } } } ], - "specLocation": "nodes/_types/Stats.ts#L968-L977" + "specLocation": "tasks/_types/TaskListResponseBase.ts#L45-L47" }, { - "kind": "interface", - "name": { - "name": "OperatingSystem", - "namespace": "nodes._types" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "cpu", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Cpu", - "namespace": "nodes._types" - } - } + "name": "disabled" }, { - "name": "mem", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExtendedMemoryStats", - "namespace": "nodes._types" - } - } + "name": "v1" + } + ], + "name": { + "name": "EcsCompatibilityType", + "namespace": "text_structure._types" + }, + "specLocation": "text_structure/_types/Structure.ts#L40-L43" + }, + { + "kind": "enum", + "members": [ + { + "name": "delimited" }, { - "name": "swap", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MemoryStats", - "namespace": "nodes._types" - } - } + "name": "ndjson" }, { - "name": "cgroup", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Cgroup", - "namespace": "nodes._types" - } - } + "name": "semi_structured_text" }, { - "name": "timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "xml" } ], - "specLocation": "nodes/_types/Stats.ts#L1016-L1022" + "name": { + "name": "FormatType", + "namespace": "text_structure._types" + }, + "specLocation": "text_structure/_types/Structure.ts#L45-L50" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "awaits_successful_execution" + }, + { + "name": "ackable" + }, + { + "name": "acked" + } + ], "name": { - "name": "Cpu", - "namespace": "nodes._types" + "name": "AcknowledgementOptions", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Action.ts#L103-L107" + }, + { + "kind": "enum", + "members": [ { - "name": "percent", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "description": "The action execution is simulated. Each action type defines its own simulation operation mode. For example, the email action creates the email that would have been sent but does not actually send it. In this mode, the action might be throttled if the current state of the watch indicates it should be.", + "name": "simulate" }, { - "name": "sys", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "description": "Similar to the `simulate` mode, except the action is not throttled even if the current state of the watch indicates it should be.", + "name": "force_simulate" }, { - "name": "sys_in_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } + "description": "Executes the action as it would have been executed if the watch had been triggered by its own trigger. The execution might be throttled if the current state of the watch indicates it should be.", + "name": "execute" }, { - "name": "total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "description": "Similar to the `execute` mode, except the action is not throttled even if the current state of the watch indicates it should be.", + "name": "force_execute" }, { - "name": "total_in_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } + "description": "The action is skipped and is not executed or simulated. Effectively forces the action to be throttled.", + "name": "skip" + } + ], + "name": { + "name": "ActionExecutionMode", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Action.ts#L67-L88" + }, + { + "kind": "enum", + "members": [ + { + "name": "success" }, { - "name": "user", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "name": "failure" }, { - "name": "user_in_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } + "name": "simulated" }, { - "name": "load_average", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - } + "name": "throttled" } ], - "specLocation": "nodes/_types/Stats.ts#L575-L584" + "name": { + "name": "ActionStatusOptions", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Action.ts#L96-L101" }, { - "inherits": { - "type": { - "name": "MemoryStats", - "namespace": "nodes._types" + "kind": "enum", + "members": [ + { + "name": "email" + }, + { + "name": "webhook" + }, + { + "name": "index" + }, + { + "name": "logging" + }, + { + "name": "slack" + }, + { + "name": "pagerduty" } + ], + "name": { + "name": "ActionType", + "namespace": "watcher._types" }, - "kind": "interface", + "specLocation": "watcher/_types/Action.ts#L58-L65" + }, + { + "kind": "type_alias", "name": { - "name": "ExtendedMemoryStats", - "namespace": "nodes._types" + "name": "Actions", + "namespace": "watcher._types" }, - "properties": [ - { - "description": "Percentage of free memory.", - "name": "free_percent", - "required": false, + "specLocation": "watcher/_types/Action.ts#L56-L56", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "IndexName", + "namespace": "_types" } }, - { - "description": "Percentage of used memory.", - "name": "used_percent", - "required": false, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "ActionStatus", + "namespace": "watcher._types" } } - ], - "specLocation": "nodes/_types/Stats.ts#L658-L667" + } }, { "kind": "interface", "name": { - "name": "MemoryStats", - "namespace": "nodes._types" + "name": "ActionStatus", + "namespace": "watcher._types" }, "properties": [ { - "description": "If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes.\nOtherwise it reports the same value as `total_in_bytes`.", - "name": "adjusted_total_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "resident", - "required": false, + "name": "ack", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AcknowledgeState", + "namespace": "watcher._types" } } }, { - "name": "resident_in_bytes", + "name": "last_execution", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ExecutionState", + "namespace": "watcher._types" } } }, { - "name": "share", + "name": "last_successful_execution", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ExecutionState", + "namespace": "watcher._types" } } }, { - "name": "share_in_bytes", + "name": "last_throttle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ThrottleState", + "namespace": "watcher._types" } } - }, + } + ], + "specLocation": "watcher/_types/Action.ts#L125-L130" + }, + { + "kind": "interface", + "name": { + "name": "AcknowledgeState", + "namespace": "watcher._types" + }, + "properties": [ { - "name": "total_virtual", - "required": false, + "name": "state", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AcknowledgementOptions", + "namespace": "watcher._types" } } }, { - "name": "total_virtual_in_bytes", - "required": false, + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateTime", "namespace": "_types" } } - }, + } + ], + "specLocation": "watcher/_types/Action.ts#L109-L112" + }, + { + "kind": "interface", + "name": { + "name": "ExecutionState", + "namespace": "watcher._types" + }, + "properties": [ { - "description": "Total amount of physical memory in bytes.", - "name": "total_in_bytes", - "required": false, + "name": "successful", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Amount of free physical memory in bytes.", - "name": "free_in_bytes", - "required": false, + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "Amount of used physical memory in bytes.", - "name": "used_in_bytes", + "name": "reason", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "nodes/_types/Stats.ts#L632-L656" + "specLocation": "watcher/_types/Action.ts#L114-L118" }, { "kind": "interface", "name": { - "name": "Cgroup", - "namespace": "nodes._types" + "name": "ThrottleState", + "namespace": "watcher._types" }, "properties": [ { - "description": "Contains statistics about `cpuacct` control group for the node.", - "name": "cpuacct", - "required": false, + "name": "reason", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CpuAcct", - "namespace": "nodes._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about `cpu` control group for the node.", - "name": "cpu", - "required": false, + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CgroupCpu", - "namespace": "nodes._types" + "name": "DateTime", + "namespace": "_types" } } + } + ], + "specLocation": "watcher/_types/Action.ts#L120-L123" + }, + { + "kind": "enum", + "members": [ + { + "name": "not_eq" }, { - "description": "Contains statistics about the memory control group for the node.", - "name": "memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CgroupMemory", - "namespace": "nodes._types" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L497-L510" - }, - { - "kind": "interface", - "name": { - "name": "CpuAcct", - "namespace": "nodes._types" - }, - "properties": [ + "name": "eq" + }, { - "description": "The `cpuacct` control group to which the Elasticsearch process belongs.", - "name": "control_group", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "lt" }, { - "description": "The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process.", - "name": "usage_nanos", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } + "name": "gt" + }, + { + "name": "lte" + }, + { + "name": "gte" } ], - "specLocation": "nodes/_types/Stats.ts#L512-L521" - }, - { - "kind": "interface", "name": { - "name": "CgroupCpu", - "namespace": "nodes._types" + "name": "ConditionOp", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Conditions.ts#L41-L48" + }, + { + "kind": "enum", + "members": [ { - "description": "The `cpu` control group to which the Elasticsearch process belongs.", - "name": "control_group", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "always" }, { - "description": "The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated.", - "name": "cfs_period_micros", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "never" }, { - "description": "The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period `cfs_period_micros`.", - "name": "cfs_quota_micros", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "script" }, { - "description": "Contains CPU statistics for the node.", - "name": "stat", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CgroupCpuStat", - "namespace": "nodes._types" - } - } + "name": "compare" + }, + { + "name": "array_compare" } ], - "specLocation": "nodes/_types/Stats.ts#L523-L540" - }, - { - "kind": "interface", "name": { - "name": "CgroupCpuStat", - "namespace": "nodes._types" + "name": "ConditionType", + "namespace": "watcher._types" }, - "properties": [ - { - "description": "The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed.", - "name": "number_of_elapsed_periods", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, + "specLocation": "watcher/_types/Conditions.ts#L64-L70" + }, + { + "kind": "enum", + "members": [ { - "description": "The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled.", - "name": "number_of_times_throttled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "http" }, { - "description": "The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled.", - "name": "time_throttled_nanos", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } + "name": "https" } ], - "specLocation": "nodes/_types/Stats.ts#L542-L555" + "name": { + "name": "ConnectionScheme", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Input.ts#L39-L42" }, { - "kind": "interface", + "docId": "cron-expressions", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-cron-expressions", + "kind": "type_alias", "name": { - "name": "CgroupMemory", - "namespace": "nodes._types" + "name": "CronExpression", + "namespace": "watcher._types" }, - "properties": [ - { - "description": "The `memory` control group to which the Elasticsearch process belongs.", - "name": "control_group", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, + "specLocation": "watcher/_types/Schedule.ts#L27-L30", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ { - "description": "The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process.\nThis value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns.\nAny value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup.", - "name": "limit_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "json" }, { - "description": "The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process.\nThis value is stored as a string for consistency with `limit_in_bytes`.", - "name": "usage_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "yaml" } ], - "specLocation": "nodes/_types/Stats.ts#L557-L573" - }, - { - "kind": "interface", "name": { - "name": "Process", - "namespace": "nodes._types" + "name": "DataAttachmentFormat", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Actions.ts#L187-L190" + }, + { + "kind": "enum", + "members": [ { - "description": "Contains CPU statistics for the node.", - "name": "cpu", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Cpu", - "namespace": "nodes._types" - } - } + "name": "sunday" }, { - "description": "Contains virtual memory statistics for the node.", - "name": "mem", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MemoryStats", - "namespace": "nodes._types" - } - } + "name": "monday" }, { - "description": "Number of opened file descriptors associated with the current or `-1` if not supported.", - "name": "open_file_descriptors", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "tuesday" }, { - "description": "Maximum number of file descriptors allowed on the system, or `-1` if not supported.", - "name": "max_file_descriptors", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "wednesday" }, { - "description": "Last time the statistics were refreshed.\nRecorded in milliseconds since the Unix Epoch.", - "name": "timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "thursday" + }, + { + "name": "friday" + }, + { + "name": "saturday" } ], - "specLocation": "nodes/_types/Stats.ts#L1024-L1046" - }, - { - "kind": "interface", "name": { - "name": "Scripting", - "namespace": "nodes._types" + "name": "Day", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Schedule.ts#L37-L45" + }, + { + "kind": "enum", + "members": [ { - "description": "Total number of times the script cache has evicted old data.", - "name": "cache_evictions", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "lowest" }, { - "description": "Total number of inline script compilations performed by the node.", - "name": "compilations", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "low" }, { - "description": "Contains this recent history of script compilations.", - "name": "compilations_history", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } + "name": "normal" }, { - "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", - "name": "compilation_limit_triggered", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "high" }, { - "name": "contexts", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Context", - "namespace": "nodes._types" - } - } - } + "name": "highest" } ], - "specLocation": "nodes/_types/Stats.ts#L1048-L1066" - }, - { - "kind": "interface", "name": { - "name": "Context", - "namespace": "nodes._types" + "name": "EmailPriority", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Actions.ts#L197-L203" + }, + { + "kind": "enum", + "members": [ { - "name": "context", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "awaits_execution" }, { - "name": "compilations", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "started" }, { - "name": "cache_evictions", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "input" }, { - "name": "compilation_limit_triggered", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L1068-L1073" - }, - { - "kind": "interface", - "name": { - "name": "ScriptCache", - "namespace": "nodes._types" - }, - "properties": [ + "name": "condition" + }, { - "description": "Total number of times the script cache has evicted old data.", - "name": "cache_evictions", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "actions" }, { - "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", - "name": "compilation_limit_triggered", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "watch_transform" }, { - "description": "Total number of inline script compilations performed by the node.", - "name": "compilations", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "aborted" }, { - "name": "context", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "finished" } ], - "specLocation": "nodes/_types/Stats.ts#L1102-L1116" - }, - { - "kind": "interface", "name": { - "name": "ThreadCount", - "namespace": "nodes._types" + "name": "ExecutionPhase", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Execution.ts#L49-L58" + }, + { + "kind": "enum", + "members": [ { - "description": "Number of active threads in the thread pool.", - "name": "active", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "awaits_execution" }, { - "description": "Number of tasks completed by the thread pool executor.", - "name": "completed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "checking" }, { - "description": "Highest number of active threads in the thread pool.", - "name": "largest", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "execution_not_needed" }, { - "description": "Number of tasks in queue for the thread pool.", - "name": "queue", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "throttled" }, { - "description": "Number of tasks rejected by the thread pool executor.", - "name": "rejected", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "executed" }, { - "description": "Number of threads in the thread pool.", - "name": "threads", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "failed" + }, + { + "name": "deleted_while_queued" + }, + { + "name": "not_executed_already_queued" } ], - "specLocation": "nodes/_types/Stats.ts#L1075-L1100" + "name": { + "name": "ExecutionStatus", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Execution.ts#L38-L47" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "head" + }, + { + "name": "get" + }, + { + "name": "post" + }, + { + "name": "put" + }, + { + "name": "delete" + } + ], "name": { - "name": "Transport", - "namespace": "nodes._types" + "name": "HttpInputMethod", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Input.ts#L59-L65" + }, + { + "kind": "enum", + "members": [ { - "description": "The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.", - "name": "inbound_handling_time_histogram", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TransportHistogram", - "namespace": "nodes._types" - } - } - } + "name": "http" }, { - "description": "The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.", - "name": "outbound_handling_time_histogram", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TransportHistogram", - "namespace": "nodes._types" - } - } - } + "name": "search" }, { - "description": "Total number of RX (receive) packets received by the node during internal cluster communication.", - "name": "rx_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "simple" + } + ], + "name": { + "name": "InputType", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Input.ts#L100-L104" + }, + { + "kind": "enum", + "members": [ + { + "name": "january" }, { - "description": "Size of RX packets received by the node during internal cluster communication.", - "name": "rx_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "february" }, { - "description": "Size, in bytes, of RX packets received by the node during internal cluster communication.", - "name": "rx_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "march" }, { - "description": "Current number of inbound TCP connections used for internal communication between nodes.", - "name": "server_open", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "april" }, { - "description": "Total number of TX (transmit) packets sent by the node during internal cluster communication.", - "name": "tx_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "may" }, { - "description": "Size of TX packets sent by the node during internal cluster communication.", - "name": "tx_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "june" }, { - "description": "Size, in bytes, of TX packets sent by the node during internal cluster communication.", - "name": "tx_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "july" }, { - "description": "The cumulative number of outbound transport connections that this node has opened since it started.\nEach transport connection may comprise multiple TCP connections but is only counted once in this statistic.\nTransport connections are typically long-lived so this statistic should remain constant in a stable cluster.", - "name": "total_outbound_connections", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "august" + }, + { + "name": "september" + }, + { + "name": "october" + }, + { + "name": "november" + }, + { + "name": "december" } ], - "specLocation": "nodes/_types/Stats.ts#L1118-L1161" + "name": { + "name": "Month", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Schedule.ts#L65-L78" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "link" + }, + { + "name": "image" + } + ], "name": { - "name": "TransportHistogram", - "namespace": "nodes._types" + "name": "PagerDutyContextType", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Actions.ts#L67-L70" + }, + { + "kind": "enum", + "members": [ { - "description": "The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.", - "name": "count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "trigger" }, { - "description": "The exclusive upper bound of the bucket in milliseconds.\nMay be omitted on the last bucket if this bucket has no upper bound.", - "name": "lt_millis", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "resolve" }, { - "description": "The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound.", - "name": "ge_millis", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "acknowledge" } ], - "specLocation": "nodes/_types/Stats.ts#L1163-L1177" - }, - { - "kind": "interface", "name": { - "name": "Discovery", - "namespace": "nodes._types" + "name": "PagerDutyEventType", + "namespace": "watcher._types" }, - "properties": [ + "specLocation": "watcher/_types/Actions.ts#L72-L76" + }, + { + "kind": "enum", + "members": [ { - "description": "Contains statistics for the cluster state queue of the node.", - "name": "cluster_state_queue", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStateQueue", - "namespace": "nodes._types" - } - } + "name": "some" }, { - "description": "Contains statistics for the published cluster states of the node.", - "name": "published_cluster_states", - "required": false, - "type": { - "kind": "instance_of", + "name": "all" + } + ], + "name": { + "name": "Quantifier", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Conditions.ts#L74-L77" + }, + { + "kind": "enum", + "members": [ + { + "name": "json" + }, + { + "name": "yaml" + }, + { + "name": "text" + } + ], + "name": { + "name": "ResponseContentType", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Input.ts#L106-L110" + }, + { + "codegenNames": [ + "text", + "hour_minute" + ], + "description": "A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure.", + "kind": "type_alias", + "name": { + "name": "ScheduleTimeOfDay", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Schedule.ts#L98-L103", + "type": { + "items": [ + { + "kind": "instance_of", "type": { - "name": "PublishedClusterStates", - "namespace": "nodes._types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HourAndMinute", + "namespace": "watcher._types" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "HourAndMinute", + "namespace": "watcher._types" + }, + "properties": [ { - "description": "Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master.\nOmitted if the node is not master-eligible.\nEvery field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`.\nThe human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter.", - "name": "cluster_state_update", - "required": false, + "name": "hour", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ClusterStateUpdate", - "namespace": "nodes._types" + "name": "integer", + "namespace": "_types" } } } }, { - "name": "serialized_cluster_states", - "required": false, + "name": "minute", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "SerializedClusterState", - "namespace": "nodes._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } + } + ], + "specLocation": "watcher/_types/Schedule.ts#L105-L108" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "all" + ], + "name": "_all" }, { - "name": "cluster_applier_stats", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ClusterAppliedStats", - "namespace": "nodes._types" - } - } + "name": "queued_watches" + }, + { + "name": "current_watches" + }, + { + "name": "pending_watches" } ], - "specLocation": "nodes/_types/Stats.ts#L201-L219" + "name": { + "name": "WatcherMetric", + "namespace": "watcher.stats" + }, + "specLocation": "watcher/stats/types.ts#L63-L69" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "stopped" + }, + { + "name": "starting" + }, + { + "name": "started" + }, + { + "name": "stopping" + } + ], "name": { - "name": "ClusterStateQueue", - "namespace": "nodes._types" + "name": "WatcherState", + "namespace": "watcher.stats" }, - "properties": [ + "specLocation": "watcher/stats/types.ts#L26-L31" + }, + { + "kind": "enum", + "members": [ { - "description": "Total number of cluster states in queue.", - "name": "total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "build" }, { - "description": "Number of pending cluster states in queue.", - "name": "pending", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "features" }, { - "description": "Number of committed cluster states in queue.", - "name": "committed", - "required": false, + "name": "license" + } + ], + "name": { + "name": "XPackCategory", + "namespace": "xpack.info" + }, + "specLocation": "xpack/info/XPackInfoRequest.ts#L52-L56" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "behaviors": [ + { "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "CommonQueryParameters", + "namespace": "_spec_utils" } } ], - "specLocation": "nodes/_types/Stats.ts#L248-L261" + "kind": "interface", + "name": { + "name": "RequestBase", + "namespace": "_types" + }, + "properties": [], + "specLocation": "_types/Base.ts#L34-L34" }, { + "description": "Implements a set of common query parameters all API's support.\nSince these can break the request structure these are listed explicitly as a behavior.\nIts up to individual clients to define support although `error_trace` and `pretty` are\nrecommended as a minimum.", "kind": "interface", "name": { - "name": "PublishedClusterStates", - "namespace": "nodes._types" + "name": "CommonQueryParameters", + "namespace": "_spec_utils" }, "properties": [ { - "description": "Number of published cluster states.", - "name": "full_states", + "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", + "name": "error_trace", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Number of incompatible differences between published cluster states.", - "name": "incompatible_diffs", + "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", + "name": "filter_path", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"eixsts_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", + "name": "human", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Number of compatible differences between published cluster states.", - "name": "compatible_diffs", + "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", + "name": "pretty", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "nodes/_types/Stats.ts#L263-L276" + "specLocation": "_spec_utils/behaviors.ts#L49-L83" }, { "kind": "interface", "name": { - "name": "ClusterStateUpdate", - "namespace": "nodes._types" + "name": "AcknowledgedResponseBase", + "namespace": "_types" }, "properties": [ { - "description": "The number of cluster state update attempts that did not change the cluster state since the node started.", - "name": "count", + "description": "For a successful response, this value is always true. On failure, an exception is returned instead.", + "name": "acknowledged", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/Base.ts#L69-L72" + }, + { + "generics": [ { - "description": "The cumulative amount of time spent computing no-op cluster state updates since the node started.", - "name": "computation_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, + "name": "TDocument", + "namespace": "async_search._types.AsyncSearchDocumentResponseBase" + } + ], + "inherits": { + "type": { + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" + } + }, + "kind": "interface", + "name": { + "name": "AsyncSearchDocumentResponseBase", + "namespace": "async_search._types" + }, + "properties": [ { - "description": "The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started.", - "name": "computation_time_millis", - "required": false, + "name": "response", + "required": true, "type": { "generics": [ { "kind": "instance_of", "type": { - "name": "UnitMillis", - "namespace": "_types" + "name": "TDocument", + "namespace": "async_search._types.AsyncSearchDocumentResponseBase" } } ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "AsyncSearch", + "namespace": "async_search._types" } } - }, + } + ], + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L50-L54" + }, + { + "kind": "interface", + "name": { + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" + }, + "properties": [ { - "description": "The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.\nThis includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`.", - "name": "publication_time", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Id", "namespace": "_types" } } }, { - "description": "The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.\nThis includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`.", - "name": "publication_time_millis", - "required": false, + "description": "When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.\nWhile the query is running, `is_partial` is always set to `true`.", + "name": "is_partial", + "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Indicates whether the search is still running or has completed.\nNOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", + "name": "is_running", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded.\nThis statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.", - "name": "context_construction_time", + "description": "Indicates when the async search will expire.", + "name": "expiration_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded.\nThis statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.", - "name": "context_construction_time_millis", - "required": false, + "name": "expiration_time_in_millis", + "required": true, "type": { "generics": [ { @@ -100783,27 +100399,25 @@ ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "EpochTime", "namespace": "_types" } } }, { - "description": "The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.", - "name": "commit_time", + "name": "start_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.", - "name": "commit_time_millis", - "required": false, + "name": "start_time_in_millis", + "required": true, "type": { "generics": [ { @@ -100816,26 +100430,25 @@ ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "EpochTime", "namespace": "_types" } } }, { - "description": "The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.", + "description": "Indicates when the async search completed. Only present\nwhen the search has completed.", "name": "completion_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.", - "name": "completion_time_millis", + "name": "completion_time_in_millis", "required": false, "type": { "generics": [ @@ -100849,122 +100462,113 @@ ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "EpochTime", "namespace": "_types" } } - }, + } + ], + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L49" + }, + { + "generics": [ + { + "name": "TDocument", + "namespace": "async_search._types.AsyncSearch" + } + ], + "kind": "interface", + "name": { + "name": "AsyncSearch", + "namespace": "async_search._types" + }, + "properties": [ { - "description": "The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started.", - "name": "master_apply_time", + "description": "Partial aggregations results, coming from the shards that have already completed the execution of the query.", + "name": "aggregations", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "AggregateName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Aggregate", + "namespace": "_types.aggregations" + } } } }, { - "description": "The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started.", - "name": "master_apply_time_millis", + "name": "_clusters", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "ClusterStatistics", "namespace": "_types" } } }, { - "description": "The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started.", - "name": "notification_time", + "name": "fields", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "description": "The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started.", - "name": "notification_time_millis", - "required": false, + "name": "hits", + "required": true, "type": { "generics": [ { "kind": "instance_of", "type": { - "name": "UnitMillis", - "namespace": "_types" + "name": "TDocument", + "namespace": "async_search._types.AsyncSearch" } } ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L278-L343" - }, - { - "kind": "interface", - "name": { - "name": "SerializedClusterState", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Number of published cluster states.", - "name": "full_states", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SerializedClusterStateDetail", - "namespace": "nodes._types" + "name": "HitsMetadata", + "namespace": "_global.search._types" } } }, { - "name": "diffs", + "name": "max_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SerializedClusterStateDetail", - "namespace": "nodes._types" + "name": "double", + "namespace": "_types" } } - } - ], - "specLocation": "nodes/_types/Stats.ts#L232-L238" - }, - { - "kind": "interface", - "name": { - "name": "SerializedClusterStateDetail", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "name": "count", + "description": "Indicates how many reductions of the results have been performed.\nIf this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response.", + "name": "num_reduce_phases", "required": false, "type": { "kind": "instance_of", @@ -100975,6700 +100579,478 @@ } }, { - "name": "uncompressed_size", + "name": "profile", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Profile", + "namespace": "_global.search._types" } } }, { - "name": "uncompressed_size_in_bytes", + "name": "pit_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "name": "compressed_size", + "name": "_scroll_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ScrollId", + "namespace": "_types" } } }, { - "name": "compressed_size_in_bytes", - "required": false, + "description": "Indicates how many shards have run the query.\nNote that in order for shard results to be included in the search response, they need to be reduced first.", + "name": "_shards", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ShardStatistics", "namespace": "_types" } } - } - ], - "specLocation": "nodes/_types/Stats.ts#L240-L246" - }, - { - "kind": "interface", - "name": { - "name": "ClusterAppliedStats", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "name": "recordings", + "name": "suggest", "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "Recording", - "namespace": "nodes._types" + "name": "SuggestionName", + "namespace": "_types" } - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L221-L223" - }, - { - "kind": "interface", - "name": { - "name": "Recording", - "namespace": "nodes._types" - }, - "properties": [ - { - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "cumulative_execution_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "cumulative_execution_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "cumulative_execution_time_millis", - "required": false, - "type": { - "generics": [ - { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "async_search._types.AsyncSearch" + } + } + ], "kind": "instance_of", "type": { - "name": "UnitMillis", - "namespace": "_types" + "name": "Suggest", + "namespace": "_global.search._types" } } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L225-L230" - }, - { - "kind": "interface", - "name": { - "name": "IndexingPressure", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Contains statistics for memory consumption from indexing load.", - "name": "memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexingPressureMemory", - "namespace": "nodes._types" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L116-L121" - }, - { - "kind": "interface", - "name": { - "name": "IndexingPressureMemory", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Configured memory limit for the indexing requests.\nReplica requests have an automatic limit that is 1.5x this value.", - "name": "limit", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Configured memory limit, in bytes, for the indexing requests.\nReplica requests have an automatic limit that is 1.5x this value.", - "name": "limit_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics for current indexing load.", - "name": "current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "PressureMemory", - "namespace": "nodes._types" - } - } - }, - { - "description": "Contains statistics for the cumulative indexing load since the node started.", - "name": "total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "PressureMemory", - "namespace": "nodes._types" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L123-L142" - }, - { - "kind": "interface", - "name": { - "name": "PressureMemory", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Memory consumed by indexing requests in the coordinating, primary, or replica stage.", - "name": "all", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.", - "name": "all_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Memory consumed by indexing requests in the coordinating or primary stage.\nThis value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.", - "name": "combined_coordinating_and_primary", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Memory consumed, in bytes, by indexing requests in the coordinating or primary stage.\nThis value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.", - "name": "combined_coordinating_and_primary_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Memory consumed by indexing requests in the coordinating stage.", - "name": "coordinating", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Memory consumed, in bytes, by indexing requests in the coordinating stage.", - "name": "coordinating_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Memory consumed by indexing requests in the primary stage.", - "name": "primary", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Memory consumed, in bytes, by indexing requests in the primary stage.", - "name": "primary_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" } } }, { - "description": "Memory consumed by indexing requests in the replica stage.", - "name": "replica", + "name": "terminated_early", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Memory consumed, in bytes, by indexing requests in the replica stage.", - "name": "replica_in_bytes", - "required": false, + "name": "timed_out", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Number of indexing requests rejected in the coordinating stage.", - "name": "coordinating_rejections", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Number of indexing requests rejected in the primary stage.", - "name": "primary_rejections", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Number of indexing requests rejected in the replica stage.", - "name": "replica_rejections", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L144-L199" - }, - { - "kind": "interface", - "name": { - "name": "ShardStats", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "commit", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardCommit", - "namespace": "indices.stats" - } - } - }, - { - "name": "completion", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CompletionStats", - "namespace": "_types" - } - } - }, - { - "name": "docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DocStats", - "namespace": "_types" - } - } - }, - { - "name": "fielddata", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FielddataStats", - "namespace": "_types" - } - } - }, - { - "name": "flush", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FlushStats", - "namespace": "_types" - } - } - }, - { - "name": "get", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GetStats", - "namespace": "_types" - } - } - }, - { - "name": "indexing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexingStats", - "namespace": "_types" - } - } - }, - { - "name": "mappings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MappingStats", - "namespace": "indices.stats" - } - } - }, - { - "name": "merges", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MergesStats", - "namespace": "_types" - } - } - }, - { - "name": "shard_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardPath", - "namespace": "indices.stats" - } - } - }, - { - "name": "query_cache", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardQueryCache", - "namespace": "indices.stats" - } - } - }, - { - "name": "recovery", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RecoveryStats", - "namespace": "_types" - } - } - }, - { - "name": "refresh", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RefreshStats", - "namespace": "_types" - } - } - }, - { - "name": "request_cache", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RequestCacheStats", - "namespace": "_types" - } - } - }, - { - "name": "retention_leases", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardRetentionLeases", - "namespace": "indices.stats" - } - } - }, - { - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardRouting", - "namespace": "indices.stats" - } - } - }, - { - "name": "search", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SearchStats", - "namespace": "_types" - } - } - }, - { - "name": "segments", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SegmentsStats", - "namespace": "_types" - } - } - }, - { - "name": "seq_no", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardSequenceNumber", - "namespace": "indices.stats" - } - } - }, - { - "name": "store", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StoreStats", - "namespace": "_types" - } - } - }, - { - "name": "translog", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TranslogStats", - "namespace": "_types" - } - } - }, - { - "name": "warmer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "WarmerStats", - "namespace": "_types" - } - } - }, - { - "name": "bulk", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "BulkStats", - "namespace": "_types" - } - } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.15.0" - } - }, - "name": "shards", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "shard_stats", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardsTotalStats", - "namespace": "indices.stats" - } - } - }, - { - "name": "indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndicesStats", - "namespace": "indices.stats" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L192-L223" - }, - { - "kind": "interface", - "name": { - "name": "ShardCommit", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "generation", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "num_docs", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "user_data", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - } - ], - "specLocation": "indices/stats/types.ts#L112-L117" - }, - { - "kind": "interface", - "name": { - "name": "CompletionStats", - "namespace": "_types" - }, - "properties": [ - { - "description": "Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.", - "name": "size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used for completion across all shards assigned to selected nodes.", - "name": "size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "FieldSizeUsage", - "namespace": "_types" - } - } - } - } - ], - "specLocation": "_types/Stats.ts#L83-L93" - }, - { - "kind": "interface", - "name": { - "name": "FieldSizeUsage", - "namespace": "_types" - }, - "properties": [ - { - "name": "size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L95-L98" - }, - { - "kind": "interface", - "name": { - "name": "DocStats", - "namespace": "_types" - }, - "properties": [ - { - "description": "Total number of non-deleted documents across all primary shards assigned to selected nodes.\nThis number is based on documents in Lucene segments and may include documents from nested fields.", - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total number of deleted documents across all primary shards assigned to selected nodes.\nThis number is based on documents in Lucene segments.\nElasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.", - "name": "deleted", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L100-L112" - }, - { - "kind": "interface", - "name": { - "name": "FielddataStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "evictions", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "memory_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "memory_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "FieldMemoryUsage", - "namespace": "_types" - } - } - } - } - ], - "specLocation": "_types/Stats.ts#L114-L119" - }, - { - "kind": "interface", - "name": { - "name": "FieldMemoryUsage", - "namespace": "_types" - }, - "properties": [ - { - "name": "memory_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "memory_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L121-L124" - }, - { - "kind": "interface", - "name": { - "name": "FlushStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "periodic", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "total_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L126-L131" - }, - { - "kind": "interface", - "name": { - "name": "GetStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "exists_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "exists_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "exists_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "missing_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "missing_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "missing_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L133-L144" - }, - { - "kind": "interface", - "name": { - "name": "IndexingStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "index_current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "delete_current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "delete_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "delete_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "delete_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "is_throttled", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "noop_update_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "throttle_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "throttle_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "index_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "index_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "index_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "index_failed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "types", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IndexingStats", - "namespace": "_types" - } - } - } - }, - { - "name": "write_load", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L146-L162" - }, - { - "kind": "interface", - "name": { - "name": "MappingStats", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "total_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_estimated_overhead", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "total_estimated_overhead_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L186-L190" - }, - { - "kind": "interface", - "name": { - "name": "MergesStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "current_docs", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "current_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "current_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_auto_throttle", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "total_auto_throttle_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_docs", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "total_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_stopped_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "total_stopped_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "total_throttled_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "total_throttled_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "total_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L164-L181" - }, - { - "kind": "interface", - "name": { - "name": "ShardPath", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "data_path", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "is_custom_data_path", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "state_path", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L140-L144" - }, - { - "kind": "interface", - "name": { - "name": "ShardQueryCache", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "cache_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "cache_size", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "evictions", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "hit_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "memory_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "miss_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L146-L154" - }, - { - "kind": "interface", - "name": { - "name": "RecoveryStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "current_as_source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "current_as_target", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "throttle_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "throttle_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L231-L236" - }, - { - "kind": "interface", - "name": { - "name": "RefreshStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "external_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "external_total_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "listeners", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "total_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L238-L245" - }, - { - "kind": "interface", - "name": { - "name": "RequestCacheStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "evictions", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "hit_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "memory_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "memory_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "miss_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L247-L253" - }, - { - "kind": "interface", - "name": { - "name": "ShardRetentionLeases", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "primary_term", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "version", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "name": "leases", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardLease", - "namespace": "indices.stats" - } - } - } - } - ], - "specLocation": "indices/stats/types.ts#L156-L160" - }, - { - "kind": "interface", - "name": { - "name": "ShardLease", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "retaining_seq_no", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SequenceNumber", - "namespace": "_types" - } - } - }, - { - "name": "timestamp", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L133-L138" - }, - { - "kind": "interface", - "name": { - "name": "ShardRouting", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "node", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "primary", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "relocating_node", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "state", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardRoutingState", - "namespace": "indices.stats" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L162-L167" - }, - { - "kind": "interface", - "name": { - "name": "SearchStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "fetch_current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "fetch_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "fetch_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "fetch_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "open_contexts", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "query_current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "query_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "query_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "query_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "scroll_current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "scroll_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "scroll_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "scroll_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "suggest_current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "suggest_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "suggest_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "suggest_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "groups", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "SearchStats", - "namespace": "_types" - } - } - } - } - ], - "specLocation": "_types/Stats.ts#L255-L274" - }, - { - "kind": "interface", - "name": { - "name": "SegmentsStats", - "namespace": "_types" - }, - "properties": [ - { - "description": "Total number of segments across all shards assigned to selected nodes.", - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used for doc values across all shards assigned to selected nodes.", - "name": "doc_values_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.", - "name": "doc_values_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "This object is not populated by the cluster stats API.\nTo get information on segment files, use the node stats API.", - "name": "file_sizes", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ShardFileSizeInfo", - "namespace": "indices.stats" - } - } - } - }, - { - "description": "Total amount of memory used by fixed bit sets across all shards assigned to selected nodes.\nFixed bit sets are used for nested object field types and type filters for join fields.", - "name": "fixed_bit_set", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.", - "name": "fixed_bit_set_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used by all index writers across all shards assigned to selected nodes.", - "name": "index_writer_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "index_writer_max_memory_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.", - "name": "index_writer_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Unix timestamp, in milliseconds, of the most recently retried indexing request.", - "name": "max_unsafe_auto_id_timestamp", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used for segments across all shards assigned to selected nodes.", - "name": "memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.", - "name": "memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used for normalization factors across all shards assigned to selected nodes.", - "name": "norms_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.", - "name": "norms_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used for points across all shards assigned to selected nodes.", - "name": "points_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.", - "name": "points_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "stored_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.", - "name": "stored_fields_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.", - "name": "terms_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used for terms across all shards assigned to selected nodes.", - "name": "terms_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used for term vectors across all shards assigned to selected nodes.", - "name": "term_vectory_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.", - "name": "term_vectors_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used by all version maps across all shards assigned to selected nodes.", - "name": "version_map_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.", - "name": "version_map_memory_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L276-L369" - }, - { - "kind": "interface", - "name": { - "name": "ShardFileSizeInfo", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "description", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "min_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "average_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L124-L131" - }, - { - "kind": "interface", - "name": { - "name": "ShardSequenceNumber", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "global_checkpoint", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "local_checkpoint", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_seq_no", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SequenceNumber", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L176-L180" - }, - { - "kind": "interface", - "name": { - "name": "StoreStats", - "namespace": "_types" - }, - "properties": [ - { - "description": "Total size of all shards assigned to selected nodes.", - "name": "size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total size, in bytes, of all shards assigned to selected nodes.", - "name": "size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.", - "name": "reserved", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.", - "name": "reserved_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total data set size of all shards assigned to selected nodes.\nThis includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.", - "name": "total_data_set_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total data set size, in bytes, of all shards assigned to selected nodes.\nThis includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.", - "name": "total_data_set_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L371-L398" - }, - { - "kind": "interface", - "name": { - "name": "TranslogStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "earliest_last_modified_age", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "operations", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "uncommitted_operations", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "uncommitted_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "uncommitted_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L400-L408" - }, - { - "kind": "interface", - "name": { - "name": "WarmerStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "total_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L410-L415" - }, - { - "kind": "interface", - "name": { - "name": "BulkStats", - "namespace": "_types" - }, - "properties": [ - { - "name": "total_operations", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "total_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "total_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "total_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "avg_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "avg_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "avg_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "avg_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L71-L81" - }, - { - "kind": "interface", - "name": { - "name": "ShardsTotalStats", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "total_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L182-L184" - }, - { - "kind": "interface", - "name": { - "name": "IndicesStats", - "namespace": "indices.stats" - }, - "properties": [ - { - "name": "primaries", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexStats", - "namespace": "indices.stats" - } - } - }, - { - "name": "shards", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardStats", - "namespace": "indices.stats" - } - } - } - } - }, - { - "name": "total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexStats", - "namespace": "indices.stats" - } - } - }, - { - "name": "uuid", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Uuid", - "namespace": "_types" - } - } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "8.1.0" - } - }, - "name": "health", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "HealthStatus", - "namespace": "_types" - } - } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "8.1.0" - } - }, - "name": "status", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexMetadataState", - "namespace": "indices.stats" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L95-L110" - }, - { - "kind": "interface", - "name": { - "name": "IndexStats", - "namespace": "indices.stats" - }, - "properties": [ - { - "description": "Contains statistics about completions across all shards assigned to the node.", - "name": "completion", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CompletionStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about documents across all primary shards assigned to the node.", - "name": "docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DocStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about the field data cache across all shards assigned to the node.", - "name": "fielddata", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FielddataStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about flush operations for the node.", - "name": "flush", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FlushStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about get operations for the node.", - "name": "get", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GetStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about indexing operations for the node.", - "name": "indexing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexingStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about indices operations for the node.", - "name": "indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndicesStats", - "namespace": "indices.stats" - } - } - }, - { - "description": "Contains statistics about merge operations for the node.", - "name": "merges", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MergesStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about the query cache across all shards assigned to the node.", - "name": "query_cache", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryCacheStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about recovery operations for the node.", - "name": "recovery", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RecoveryStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about refresh operations for the node.", - "name": "refresh", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RefreshStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about the request cache across all shards assigned to the node.", - "name": "request_cache", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RequestCacheStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about search operations for the node.", - "name": "search", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SearchStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about segments across all shards assigned to the node.", - "name": "segments", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SegmentsStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about the size of shards assigned to the node.", - "name": "store", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StoreStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about transaction log operations for the node.", - "name": "translog", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TranslogStats", - "namespace": "_types" - } - } - }, - { - "description": "Contains statistics about index warming operations for the node.", - "name": "warmer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "WarmerStats", - "namespace": "_types" - } - } - }, - { - "name": "bulk", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "BulkStats", - "namespace": "_types" - } - } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.15.0" - } - }, - "name": "shard_stats", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardsTotalStats", - "namespace": "indices.stats" - } - } - } - ], - "specLocation": "indices/stats/types.ts#L52-L93" - }, - { - "kind": "interface", - "name": { - "name": "QueryCacheStats", - "namespace": "_types" - }, - "properties": [ - { - "description": "Total number of entries added to the query cache across all shards assigned to selected nodes.\nThis number includes current and evicted entries.", - "name": "cache_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total number of entries currently in the query cache across all shards assigned to selected nodes.", - "name": "cache_size", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total number of query cache evictions across all shards assigned to selected nodes.", - "name": "evictions", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total count of query cache hits across all shards assigned to selected nodes.", - "name": "hit_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total amount of memory used for the query cache across all shards assigned to selected nodes.", - "name": "memory_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.", - "name": "memory_size_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total count of query cache misses across all shards assigned to selected nodes.", - "name": "miss_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total count of hits and misses in the query cache across all shards assigned to selected nodes.", - "name": "total_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Stats.ts#L195-L229" - }, - { - "kind": "interface", - "name": { - "name": "NodeReloadError", - "namespace": "nodes._types" - }, - "properties": [ - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "reload_exception", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ErrorCause", - "namespace": "_types" - } - } - } - ], - "specLocation": "nodes/_types/NodeReloadResult.ts#L24-L27" - }, - { - "kind": "enum", - "members": [ - { - "name": "global" - }, - { - "name": "exact" - }, - { - "name": "exact_fuzzy" - }, - { - "name": "fuzzy" - }, - { - "name": "prefix" - }, - { - "name": "suffix" - }, - { - "name": "contains" - }, - { - "name": "lt" - }, - { - "name": "lte" - }, - { - "name": "gt" - }, - { - "name": "gte" - }, - { - "name": "always" - } - ], - "name": { - "name": "QueryRuleCriteriaType", - "namespace": "query_rules._types" - }, - "specLocation": "query_rules/_types/QueryRuleset.ts#L95-L108" - }, - { - "kind": "enum", - "members": [ - { - "name": "pinned" - }, - { - "name": "exclude" - } - ], - "name": { - "name": "QueryRuleType", - "namespace": "query_rules._types" - }, - "specLocation": "query_rules/_types/QueryRuleset.ts#L60-L63" - }, - { - "kind": "enum", - "members": [ - { - "name": "min" - }, - { - "name": "max" - }, - { - "name": "sum" - }, - { - "name": "avg" - }, - { - "name": "value_count" - } - ], - "name": { - "name": "Metric", - "namespace": "rollup._types" - }, - "specLocation": "rollup/_types/Metric.ts#L22-L28" - }, - { - "kind": "enum", - "members": [ - { - "name": "started" - }, - { - "name": "indexing" - }, - { - "name": "stopping" - }, - { - "name": "stopped" - }, - { - "name": "aborting" - } - ], - "name": { - "name": "IndexingJobState", - "namespace": "rollup.get_jobs" - }, - "specLocation": "rollup/get_jobs/types.ts#L77-L83" - }, - { - "kind": "enum", - "members": [ - { - "codegenName": "PageView", - "name": "page_view" - }, - { - "codegenName": "Search", - "name": "search" - }, - { - "codegenName": "SearchClick", - "name": "search_click" - } - ], - "name": { - "name": "EventType", - "namespace": "search_application._types" - }, - "specLocation": "search_application/_types/AnalyticsEvent.ts#L22-L26" - }, - { - "kind": "enum", - "members": [ - { - "name": "cluster" - }, - { - "name": "indices" - }, - { - "name": "shards" - } - ], - "name": { - "name": "StatsLevel", - "namespace": "searchable_snapshots._types" - }, - "specLocation": "searchable_snapshots/_types/stats.ts#L20-L24" - }, - { - "kind": "enum", - "members": [ - { - "name": "rest" - }, - { - "name": "cross_cluster" - } - ], - "name": { - "name": "ApiKeyType", - "namespace": "security._types" - }, - "specLocation": "security/_types/ApiKey.ts#L115-L118" - }, - { - "isOpen": true, - "kind": "enum", - "members": [ - { - "name": "all" - }, - { - "name": "cancel_task" - }, - { - "name": "manage" - }, - { - "name": "manage_api_key" - }, - { - "name": "manage_behavioral_analytics" - }, - { - "name": "manage_enrich" - }, - { - "name": "manage_index_templates" - }, - { - "name": "manage_inference" - }, - { - "name": "manage_ingest_pipelines" - }, - { - "name": "manage_logstash_pipelines" - }, - { - "name": "manage_ml" - }, - { - "name": "manage_own_api_key" - }, - { - "name": "manage_pipeline" - }, - { - "name": "manage_search_application" - }, - { - "name": "manage_search_query_rules" - }, - { - "name": "manage_search_synonyms" - }, - { - "name": "manage_security" - }, - { - "name": "manage_transform" - }, - { - "name": "monitor" - }, - { - "name": "monitor_enrich" - }, - { - "name": "monitor_inference" - }, - { - "name": "monitor_ml" - }, - { - "name": "monitor_transform" - }, - { - "name": "none" - }, - { - "name": "post_behavioral_analytics_event" - }, - { - "name": "read_pipeline" - }, - { - "name": "read_security" - } - ], - "name": { - "name": "ClusterPrivilege", - "namespace": "security._types" - }, - "specLocation": "security/_types/Privileges.ts#L42-L199" - }, - { - "kind": "enum", - "members": [ - { - "description": "In this type of grant, you must supply the user ID and password for which you want to create the API key.", - "name": "password" - }, - { - "description": "In this type of grant, you must supply an access token that was created by the Elasticsearch token service.\nIf you are activating a user profile, you can alternatively supply a JWT (either a JWT `access_token` or a JWT `id_token`).", - "name": "access_token" - } - ], - "name": { - "name": "GrantType", - "namespace": "security._types" - }, - "specLocation": "security/_types/GrantType.ts#L20-L30" - }, - { - "isOpen": true, - "kind": "enum", - "members": [ - { - "name": "all" - }, - { - "name": "auto_configure" - }, - { - "name": "create" - }, - { - "name": "create_doc" - }, - { - "name": "create_index" - }, - { - "name": "delete" - }, - { - "name": "delete_index" - }, - { - "name": "index" - }, - { - "name": "maintenance" - }, - { - "name": "manage" - }, - { - "name": "manage_data_stream_lifecycle" - }, - { - "name": "monitor" - }, - { - "name": "none" - }, - { - "name": "read" - }, - { - "name": "view_index_metadata" - }, - { - "name": "write" - } - ], - "name": { - "name": "IndexPrivilege", - "namespace": "security._types" - }, - "specLocation": "security/_types/Privileges.ts#L387-L429" - }, - { - "codegenNames": [ - "json_text", - "query", - "template" - ], - "description": "While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts.", - "kind": "type_alias", - "name": { - "name": "IndicesPrivilegesQuery", - "namespace": "security._types" - }, - "specLocation": "security/_types/Privileges.ts#L342-L350", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RoleTemplateQuery", - "namespace": "security._types" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "RoleTemplateQuery", - "namespace": "security._types" - }, - "properties": [ - { - "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.", - "extDocId": "templating-role-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query", - "name": "template", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RoleTemplateScript", - "namespace": "security._types" - } - } - } - ], - "specLocation": "security/_types/Privileges.ts#L352-L362" - }, - { - "kind": "interface", - "name": { - "name": "RoleTemplateScript", - "namespace": "security._types" - }, - "properties": [ - { - "name": "source", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RoleTemplateInlineQuery", - "namespace": "security._types" - } - } - }, - { - "description": "The `id` for a stored script.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", - "name": "params", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "description": "Specifies the language the script is written in.", - "name": "lang", - "required": false, - "serverDefault": "painless", - "type": { - "kind": "instance_of", - "type": { - "name": "ScriptLanguage", - "namespace": "_types" - } - } - }, - { - "name": "options", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - } - ], - "shortcutProperty": "source", - "specLocation": "security/_types/Privileges.ts#L364-L382" - }, - { - "codegenNames": [ - "query_string", - "query_object" - ], - "kind": "type_alias", - "name": { - "name": "RoleTemplateInlineQuery", - "namespace": "security._types" - }, - "specLocation": "security/_types/Privileges.ts#L384-L385", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [], - "name": { - "name": "RemoteClusterPrivilege", - "namespace": "security._types" - }, - "specLocation": "security/_types/Privileges.ts#L201-L214" - }, - { - "isOpen": true, - "kind": "enum", - "members": [ - { - "name": "search_application_query" - } - ], - "name": { - "name": "RestrictionWorkflow", - "namespace": "security._types" - }, - "specLocation": "security/_types/RoleDescriptor.ts#L143-L146" - }, - { - "kind": "enum", - "members": [ - { - "name": "string" - }, - { - "name": "json" - } - ], - "name": { - "name": "TemplateFormat", - "namespace": "security._types" - }, - "specLocation": "security/_types/RoleTemplate.ts#L22-L25" - }, - { - "kind": "type_alias", - "name": { - "name": "UserProfileId", - "namespace": "security._types" - }, - "specLocation": "security/_types/UserProfile.ts#L25-L25", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ - { - "description": "This grant type implements the Resource Owner Password Credentials Grant of OAuth2.\nIn this grant, a trusted client exchanges the end user's credentials for an access token and (possibly) a refresh token.\nThe request needs to be made by an authenticated user but happens on behalf of another authenticated user (the one whose credentials are passed as request parameters).\nThis grant type is not suitable or designed for the self-service user creation of tokens.", - "name": "password" - }, - { - "description": "This grant type implements the Client Credentials Grant of OAuth2.\nIt is geared for machine to machine communication and is not suitable or designed for the self-service user creation of tokens.\nIt generates only access tokens that cannot be refreshed.\nThe premise is that the entity that uses `client_credentials` has constant access to a set of (client, not end-user) credentials and can authenticate itself at will.", - "name": "client_credentials" - }, - { - "description": "This grant type is supported internally and implements SPNEGO based Kerberos support.\nThe `_kerberos` grant type may change from version to version.", - "name": "_kerberos" - }, - { - "description": "This grant type implements the Refresh Token Grant of OAuth2.\nIn this grant a user exchanges a previously issued refresh token for a new access token and a new refresh token.", - "name": "refresh_token" - } - ], - "name": { - "name": "AccessTokenGrantType", - "namespace": "security.get_token" - }, - "specLocation": "security/get_token/types.ts#L23-L48" - }, - { - "kind": "enum", - "members": [ - { - "name": "access_token" - }, - { - "name": "password" - } - ], - "name": { - "name": "ApiKeyGrantType", - "namespace": "security.grant_api_key" - }, - "specLocation": "security/grant_api_key/types.ts#L47-L50" - }, - { - "kind": "type_alias", - "name": { - "name": "ApplicationsPrivileges", - "namespace": "security.has_privileges" - }, - "specLocation": "security/has_privileges/types.ts#L47-L47", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ResourcePrivileges", - "namespace": "security.has_privileges" - } - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "ResourcePrivileges", - "namespace": "security.has_privileges" - }, - "specLocation": "security/has_privileges/types.ts#L48-L48", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Privileges", - "namespace": "security.has_privileges" - } - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "Privileges", - "namespace": "security.has_privileges" - }, - "specLocation": "security/has_privileges/types.ts#L49-L49", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "ApiKeyAggregate", - "namespace": "security.query_api_keys" - }, - "specLocation": "security/query_api_keys/types.ts#L122-L139", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "CardinalityAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ValueCountAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StringTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LongTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DoubleTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "UnmappedTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MultiTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MissingAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "FilterAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "FiltersAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RangeAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DateRangeAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "CompositeAggregate", - "namespace": "_types.aggregations" - } - } - ], - "kind": "union_of" - }, - "variants": { - "kind": "external_tag", - "nonExhaustive": true - } - }, - { - "kind": "enum", - "members": [ - { - "name": "restart" - }, - { - "name": "remove" - }, - { - "name": "replace" - } - ], - "name": { - "name": "Type", - "namespace": "shutdown._types" - }, - "specLocation": "shutdown/_types/types.ts#L20-L24" - }, - { - "kind": "enum", - "members": [ - { - "name": "not_started" - }, - { - "name": "in_progress" - }, - { - "name": "stalled" - }, - { - "name": "complete" - } - ], - "name": { - "name": "ShutdownStatus", - "namespace": "shutdown.get_node" - }, - "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L45-L50" - }, - { - "kind": "enum", - "members": [ - { - "name": "remove" - }, - { - "name": "restart" - } - ], - "name": { - "name": "ShutdownType", - "namespace": "shutdown.get_node" - }, - "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L40-L43" - }, - { - "kind": "type_alias", - "name": { - "name": "Repository", - "namespace": "snapshot._types" - }, - "specLocation": "snapshot/_types/SnapshotRepository.ts#L24-L34", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "AzureRepository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GcsRepository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "S3Repository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SharedFileSystemRepository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ReadOnlyUrlRepository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SourceOnlyRepository", - "namespace": "snapshot._types" - } - } - ], - "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "nonExhaustive": true, - "tag": "type" - } - }, - { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "AzureRepository", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "azure" - } - }, - { - "name": "settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AzureRepositorySettings", - "namespace": "snapshot._types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L40-L43" - }, - { - "kind": "interface", - "name": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "uuid", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Uuid", - "namespace": "_types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L36-L38" - }, - { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "AzureRepositorySettings", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "client", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "container", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "base_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "readonly", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "location_mode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L77-L83" - }, - { - "kind": "interface", - "name": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "chunk_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "compress", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "max_restore_bytes_per_sec", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "max_snapshot_bytes_per_sec", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L70-L75" - }, - { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "GcsRepository", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "gcs" - } - }, - { - "name": "settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "GcsRepositorySettings", - "namespace": "snapshot._types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L45-L48" - }, - { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "GcsRepositorySettings", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "bucket", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "client", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "base_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "readonly", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "application_name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L85-L91" - }, - { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "S3Repository", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "s3" - } - }, - { - "name": "settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "S3RepositorySettings", - "namespace": "snapshot._types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L50-L53" - }, - { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "S3RepositorySettings", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "bucket", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "client", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "base_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "readonly", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "server_side_encryption", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "buffer_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "canned_acl", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "storage_class", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L93-L102" - }, - { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "SharedFileSystemRepository", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "fs" - } - }, - { - "name": "settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SharedFileSystemRepositorySettings", - "namespace": "snapshot._types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L55-L58" - }, - { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "SharedFileSystemRepositorySettings", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "location", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "max_number_of_snapshots", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "readonly", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L104-L108" - }, - { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "ReadOnlyUrlRepository", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "url" - } - }, - { - "name": "settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ReadOnlyUrlRepositorySettings", - "namespace": "snapshot._types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L60-L63" - }, - { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "ReadOnlyUrlRepositorySettings", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "http_max_retries", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "http_socket_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "max_number_of_snapshots", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "url", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L110-L115" - }, - { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "SourceOnlyRepository", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "source" - } - }, - { - "name": "settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceOnlyRepositorySettings", - "namespace": "snapshot._types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L65-L68" - }, - { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "SourceOnlyRepositorySettings", - "namespace": "snapshot._types" - }, - "properties": [ - { - "name": "delegate_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "max_number_of_snapshots", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "aliases": [ - "readonly" - ], - "name": "read_only", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L117-L124" - }, - { - "kind": "enum", - "members": [ - { - "description": "Number of shards in the snapshot that were successfully stored in the repository.", - "name": "DONE" - }, - { - "description": "Number of shards in the snapshot that were not successfully stored in the repository.", - "name": "FAILURE" - }, - { - "description": "Number of shards in the snapshot that are in the finalizing stage of being stored in the repository.", - "name": "FINALIZE" - }, - { - "description": "Number of shards in the snapshot that are in the initializing stage of being stored in the repository.", - "name": "INIT" - }, - { - "description": "Number of shards in the snapshot that are in the started stage of being stored in the repository.", - "name": "STARTED" - } - ], - "name": { - "name": "ShardsStatsStage", - "namespace": "snapshot._types" - }, - "specLocation": "snapshot/_types/SnapshotShardsStatsStage.ts#L20-L31" - }, - { - "kind": "enum", - "members": [ - { - "name": "start_time" - }, - { - "name": "duration" - }, - { - "name": "name" - }, - { - "name": "index_count" - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "repository" - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "shard_count" - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "failed_shard_count" - } - ], - "name": { - "name": "SnapshotSort", - "namespace": "snapshot._types" - }, - "specLocation": "snapshot/_types/SnapshotInfo.ts#L73-L93" - }, - { - "kind": "type_alias", - "name": { - "name": "Row", - "namespace": "sql" - }, - "specLocation": "sql/types.ts#L28-L28", - "type": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" - } - } - }, - { - "kind": "enum", - "members": [ - { - "name": "csv" - }, - { - "name": "json" - }, - { - "name": "tsv" - }, - { - "name": "txt" - }, - { - "name": "yaml" - }, - { - "name": "cbor" - }, - { - "name": "smile" - } - ], - "name": { - "name": "SqlFormat", - "namespace": "sql.query" - }, - "specLocation": "sql/query/QuerySqlRequest.ts#L148-L156" - }, - { - "kind": "type_alias", - "name": { - "name": "SynonymString", - "namespace": "synonyms._types" - }, - "specLocation": "synonyms/_types/SynonymRule.ts#L23-L23", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ - { - "description": "Group tasks by node ID.", - "name": "nodes" - }, - { - "description": "Group tasks by parent task ID.", - "name": "parents" - }, - { - "description": "Do not group tasks.", - "name": "none" - } - ], - "name": { - "name": "GroupBy", - "namespace": "tasks._types" - }, - "specLocation": "tasks/_types/GroupBy.ts#L20-L27" - }, - { - "codegenNames": [ - "flat", - "grouped" - ], - "kind": "type_alias", - "name": { - "name": "TaskInfos", - "namespace": "tasks._types" - }, - "specLocation": "tasks/_types/TaskListResponseBase.ts#L40-L43", - "type": { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TaskInfo", - "namespace": "tasks._types" - } - } - }, - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ParentTaskInfo", - "namespace": "tasks._types" - } - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "TaskInfo", - "namespace": "tasks._types" - }, - "properties": [ - { - "name": "action", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "cancelled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "cancellable", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.", - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "headers", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "node", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeId", - "namespace": "_types" - } - } - }, - { - "name": "running_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "running_time_in_nanos", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "name": "start_time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - }, - { - "description": "The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.", - "name": "status", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "parent_task_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskId", - "namespace": "_types" - } - } - } - ], - "specLocation": "tasks/_types/TaskInfo.ts#L32-L58" - }, - { - "inherits": { - "type": { - "name": "TaskInfo", - "namespace": "tasks._types" - } - }, - "kind": "interface", - "name": { - "name": "ParentTaskInfo", - "namespace": "tasks._types" - }, - "properties": [ - { - "name": "children", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TaskInfo", - "namespace": "tasks._types" - } - } - } - } - ], - "specLocation": "tasks/_types/TaskListResponseBase.ts#L45-L47" - }, - { - "kind": "enum", - "members": [ - { - "name": "disabled" - }, - { - "name": "v1" - } - ], - "name": { - "name": "EcsCompatibilityType", - "namespace": "text_structure._types" - }, - "specLocation": "text_structure/_types/Structure.ts#L40-L43" - }, - { - "kind": "enum", - "members": [ - { - "name": "delimited" - }, - { - "name": "ndjson" - }, - { - "name": "semi_structured_text" - }, - { - "name": "xml" - } - ], - "name": { - "name": "FormatType", - "namespace": "text_structure._types" - }, - "specLocation": "text_structure/_types/Structure.ts#L45-L50" - }, - { - "kind": "enum", - "members": [ - { - "name": "awaits_successful_execution" - }, - { - "name": "ackable" - }, - { - "name": "acked" - } - ], - "name": { - "name": "AcknowledgementOptions", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Action.ts#L103-L107" - }, - { - "kind": "enum", - "members": [ - { - "description": "The action execution is simulated. Each action type defines its own simulation operation mode. For example, the email action creates the email that would have been sent but does not actually send it. In this mode, the action might be throttled if the current state of the watch indicates it should be.", - "name": "simulate" - }, - { - "description": "Similar to the `simulate` mode, except the action is not throttled even if the current state of the watch indicates it should be.", - "name": "force_simulate" - }, - { - "description": "Executes the action as it would have been executed if the watch had been triggered by its own trigger. The execution might be throttled if the current state of the watch indicates it should be.", - "name": "execute" - }, - { - "description": "Similar to the `execute` mode, except the action is not throttled even if the current state of the watch indicates it should be.", - "name": "force_execute" - }, - { - "description": "The action is skipped and is not executed or simulated. Effectively forces the action to be throttled.", - "name": "skip" - } - ], - "name": { - "name": "ActionExecutionMode", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Action.ts#L67-L88" - }, - { - "kind": "enum", - "members": [ - { - "name": "success" - }, - { - "name": "failure" - }, - { - "name": "simulated" - }, - { - "name": "throttled" - } - ], - "name": { - "name": "ActionStatusOptions", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Action.ts#L96-L101" - }, - { - "kind": "enum", - "members": [ - { - "name": "email" - }, - { - "name": "webhook" - }, - { - "name": "index" - }, - { - "name": "logging" - }, - { - "name": "slack" - }, - { - "name": "pagerduty" - } - ], - "name": { - "name": "ActionType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Action.ts#L58-L65" - }, - { - "kind": "type_alias", - "name": { - "name": "Actions", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Action.ts#L56-L56", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ActionStatus", - "namespace": "watcher._types" - } - } - } - }, - { - "kind": "interface", - "name": { - "name": "ActionStatus", - "namespace": "watcher._types" - }, - "properties": [ - { - "name": "ack", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AcknowledgeState", - "namespace": "watcher._types" - } - } - }, - { - "name": "last_execution", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExecutionState", - "namespace": "watcher._types" - } - } - }, - { - "name": "last_successful_execution", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExecutionState", - "namespace": "watcher._types" - } - } - }, - { - "name": "last_throttle", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ThrottleState", - "namespace": "watcher._types" - } - } - } - ], - "specLocation": "watcher/_types/Action.ts#L125-L130" - }, - { - "kind": "interface", - "name": { - "name": "AcknowledgeState", - "namespace": "watcher._types" - }, - "properties": [ - { - "name": "state", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AcknowledgementOptions", - "namespace": "watcher._types" - } - } - }, - { - "name": "timestamp", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - } - ], - "specLocation": "watcher/_types/Action.ts#L109-L112" - }, - { - "kind": "interface", - "name": { - "name": "ExecutionState", - "namespace": "watcher._types" - }, - "properties": [ - { - "name": "successful", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "timestamp", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "name": "reason", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "watcher/_types/Action.ts#L114-L118" - }, - { - "kind": "interface", - "name": { - "name": "ThrottleState", - "namespace": "watcher._types" - }, - "properties": [ - { - "name": "reason", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "timestamp", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - } - ], - "specLocation": "watcher/_types/Action.ts#L120-L123" - }, - { - "kind": "enum", - "members": [ - { - "name": "not_eq" - }, - { - "name": "eq" - }, - { - "name": "lt" - }, - { - "name": "gt" - }, - { - "name": "lte" - }, - { - "name": "gte" - } - ], - "name": { - "name": "ConditionOp", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Conditions.ts#L41-L48" - }, - { - "kind": "enum", - "members": [ - { - "name": "always" - }, - { - "name": "never" - }, - { - "name": "script" - }, - { - "name": "compare" - }, - { - "name": "array_compare" - } - ], - "name": { - "name": "ConditionType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Conditions.ts#L64-L70" - }, - { - "kind": "enum", - "members": [ - { - "name": "http" - }, - { - "name": "https" - } - ], - "name": { - "name": "ConnectionScheme", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Input.ts#L39-L42" - }, - { - "docId": "cron-expressions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-cron-expressions", - "kind": "type_alias", - "name": { - "name": "CronExpression", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Schedule.ts#L27-L30", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ - { - "name": "json" - }, - { - "name": "yaml" - } - ], - "name": { - "name": "DataAttachmentFormat", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Actions.ts#L187-L190" - }, - { - "kind": "enum", - "members": [ - { - "name": "sunday" - }, - { - "name": "monday" - }, - { - "name": "tuesday" - }, - { - "name": "wednesday" - }, - { - "name": "thursday" - }, - { - "name": "friday" - }, - { - "name": "saturday" - } - ], - "name": { - "name": "Day", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Schedule.ts#L37-L45" - }, - { - "kind": "enum", - "members": [ - { - "name": "lowest" - }, - { - "name": "low" - }, - { - "name": "normal" - }, - { - "name": "high" - }, - { - "name": "highest" - } - ], - "name": { - "name": "EmailPriority", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Actions.ts#L197-L203" - }, - { - "kind": "enum", - "members": [ - { - "name": "awaits_execution" - }, - { - "name": "started" - }, - { - "name": "input" - }, - { - "name": "condition" - }, - { - "name": "actions" - }, - { - "name": "watch_transform" - }, - { - "name": "aborted" - }, - { - "name": "finished" - } - ], - "name": { - "name": "ExecutionPhase", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Execution.ts#L49-L58" - }, - { - "kind": "enum", - "members": [ - { - "name": "awaits_execution" - }, - { - "name": "checking" - }, - { - "name": "execution_not_needed" - }, - { - "name": "throttled" - }, - { - "name": "executed" - }, - { - "name": "failed" - }, - { - "name": "deleted_while_queued" - }, - { - "name": "not_executed_already_queued" - } - ], - "name": { - "name": "ExecutionStatus", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Execution.ts#L38-L47" - }, - { - "kind": "enum", - "members": [ - { - "name": "head" - }, - { - "name": "get" - }, - { - "name": "post" - }, - { - "name": "put" - }, - { - "name": "delete" - } - ], - "name": { - "name": "HttpInputMethod", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Input.ts#L59-L65" - }, - { - "kind": "enum", - "members": [ - { - "name": "http" - }, - { - "name": "search" - }, - { - "name": "simple" - } - ], - "name": { - "name": "InputType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Input.ts#L100-L104" - }, - { - "kind": "enum", - "members": [ - { - "name": "january" - }, - { - "name": "february" - }, - { - "name": "march" - }, - { - "name": "april" - }, - { - "name": "may" - }, - { - "name": "june" - }, - { - "name": "july" - }, - { - "name": "august" - }, - { - "name": "september" - }, - { - "name": "october" - }, - { - "name": "november" - }, - { - "name": "december" - } - ], - "name": { - "name": "Month", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Schedule.ts#L65-L78" - }, - { - "kind": "enum", - "members": [ - { - "name": "link" - }, - { - "name": "image" - } - ], - "name": { - "name": "PagerDutyContextType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Actions.ts#L67-L70" - }, - { - "kind": "enum", - "members": [ - { - "name": "trigger" - }, - { - "name": "resolve" - }, - { - "name": "acknowledge" - } - ], - "name": { - "name": "PagerDutyEventType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Actions.ts#L72-L76" - }, - { - "kind": "enum", - "members": [ - { - "name": "some" - }, - { - "name": "all" - } - ], - "name": { - "name": "Quantifier", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Conditions.ts#L74-L77" - }, - { - "kind": "enum", - "members": [ - { - "name": "json" - }, - { - "name": "yaml" - }, - { - "name": "text" - } - ], - "name": { - "name": "ResponseContentType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Input.ts#L106-L110" - }, - { - "codegenNames": [ - "text", - "hour_minute" - ], - "description": "A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure.", - "kind": "type_alias", - "name": { - "name": "ScheduleTimeOfDay", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Schedule.ts#L98-L103", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } - }, - { + } + }, + { + "name": "took", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "HourAndMinute", - "namespace": "watcher._types" + "name": "long", + "namespace": "_types" } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "async_search/_types/AsyncSearch.ts#L30-L56" }, { + "inherits": { + "type": { + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" + } + }, "kind": "interface", "name": { - "name": "HourAndMinute", - "namespace": "watcher._types" + "name": "StatusResponseBase", + "namespace": "async_search.status" }, "properties": [ { - "name": "hour", + "description": "Indicates how many shards have run the query so far.", + "name": "_shards", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "ShardStatistics", + "namespace": "_types" } } }, { - "name": "minute", - "required": true, + "description": "Metadata about clusters involved in the cross-cluster search.\nNot shown for local-only searches.", + "name": "_clusters", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "ClusterStatistics", + "namespace": "_types" + } + } + }, + { + "description": "If the async search completed, this field shows the status code of the search.\nFor example, 200 indicates that the async search was successfully completed.\n503 indicates that the async search was completed with an error.", + "name": "completion_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "watcher/_types/Schedule.ts#L105-L108" + "specLocation": "async_search/status/AsyncSearchStatusResponse.ts#L24-L38" }, { - "kind": "enum", - "members": [ - { - "aliases": [ - "all" - ], - "name": "_all" - }, + "kind": "interface", + "name": { + "name": "SlicedScroll", + "namespace": "_types" + }, + "properties": [ { - "name": "queued_watches" + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } }, { - "name": "current_watches" + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } }, { - "name": "pending_watches" + "name": "max", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ], - "name": { - "name": "WatcherMetric", - "namespace": "watcher.stats" - }, - "specLocation": "watcher/stats/types.ts#L63-L69" + "specLocation": "_types/SlicedScroll.ts#L23-L27" }, { - "kind": "enum", - "members": [ + "kind": "interface", + "name": { + "name": "OperationContainer", + "namespace": "_global.bulk" + }, + "properties": [ { - "name": "stopped" + "description": "Index the specified document.\nIf the document exists, it replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexOperation", + "namespace": "_global.bulk" + } + } }, { - "name": "starting" + "description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", + "name": "create", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CreateOperation", + "namespace": "_global.bulk" + } + } }, { - "name": "started" + "description": "Perform a partial document update.\nThe following line must contain the partial document and update options.", + "name": "update", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "UpdateOperation", + "namespace": "_global.bulk" + } + } }, { - "name": "stopping" + "description": "Remove the specified document from the index.", + "name": "delete", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DeleteOperation", + "namespace": "_global.bulk" + } + } } ], + "specLocation": "_global/bulk/types.ts#L158-L180", + "variants": { + "kind": "container" + } + }, + { + "inherits": { + "type": { + "name": "WriteOperation", + "namespace": "_global.bulk" + } + }, + "kind": "interface", "name": { - "name": "WatcherState", - "namespace": "watcher.stats" + "name": "IndexOperation", + "namespace": "_global.bulk" }, - "specLocation": "watcher/stats/types.ts#L26-L31" + "properties": [], + "specLocation": "_global/bulk/types.ts#L142-L142" }, { - "kind": "enum", - "members": [ + "inherits": { + "type": { + "name": "OperationBase", + "namespace": "_global.bulk" + } + }, + "kind": "interface", + "name": { + "name": "WriteOperation", + "namespace": "_global.bulk" + }, + "properties": [ { - "name": "build" + "description": "A map from the full name of fields to the name of dynamic templates.\nIt defaults to an empty map.\nIf a name matches a dynamic template, that template will be applied regardless of other match predicates defined in the template.\nIf a field is already defined in the mapping, then this parameter won't be used.", + "name": "dynamic_templates", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } }, { - "name": "features" + "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.", + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "license" - } - ], - "name": { - "name": "XPackCategory", - "namespace": "xpack.info" - }, - "specLocation": "xpack/info/XPackInfoRequest.ts#L52-L56" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "behaviors": [ - { + "description": "If `true`, the request's actions must target an index alias.", + "name": "require_alias", + "required": false, + "serverDefault": false, "type": { - "name": "CommonQueryParameters", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } ], - "kind": "interface", - "name": { - "name": "RequestBase", - "namespace": "_types" - }, - "properties": [], - "specLocation": "_types/Base.ts#L34-L34" + "specLocation": "_global/bulk/types.ts#L119-L138" }, { - "description": "Implements a set of common query parameters all API's support.\nSince these can break the request structure these are listed explicitly as a behavior.\nIts up to individual clients to define support although `error_trace` and `pretty` are\nrecommended as a minimum.", "kind": "interface", "name": { - "name": "CommonQueryParameters", - "namespace": "_spec_utils" + "name": "OperationBase", + "namespace": "_global.bulk" }, "properties": [ { - "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", - "name": "error_trace", + "description": "The document ID.", + "name": "_id", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", - "name": "filter_path", + "description": "The name of the index or index alias to perform the action on.", + "name": "_index", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } } }, { - "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"eixsts_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", - "name": "human", + "description": "A custom value used to route operations to a specific shard.", + "name": "routing", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Routing", + "namespace": "_types" } } }, { - "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", - "name": "pretty", + "name": "if_primary_term", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "if_seq_no", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "version_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionType", + "namespace": "_types" } } } ], - "specLocation": "_spec_utils/behaviors.ts#L49-L83" + "specLocation": "_global/bulk/types.ts#L100-L117" }, { + "inherits": { + "type": { + "name": "WriteOperation", + "namespace": "_global.bulk" + } + }, "kind": "interface", "name": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "CreateOperation", + "namespace": "_global.bulk" + }, + "properties": [], + "specLocation": "_global/bulk/types.ts#L140-L140" + }, + { + "inherits": { + "type": { + "name": "OperationBase", + "namespace": "_global.bulk" + } + }, + "kind": "interface", + "name": { + "name": "UpdateOperation", + "namespace": "_global.bulk" }, "properties": [ { - "description": "For a successful response, this value is always true. On failure, an exception is returned instead.", - "name": "acknowledged", - "required": true, + "description": "If `true`, the request's actions must target an index alias.", + "name": "require_alias", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -107676,74 +101058,109 @@ "namespace": "_builtins" } } + }, + { + "description": "The number of times an update should be retried in the case of a version conflict.", + "name": "retry_on_conflict", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ], - "specLocation": "_types/Base.ts#L69-L72" + "specLocation": "_global/bulk/types.ts#L146-L156" + }, + { + "inherits": { + "type": { + "name": "OperationBase", + "namespace": "_global.bulk" + } + }, + "kind": "interface", + "name": { + "name": "DeleteOperation", + "namespace": "_global.bulk" + }, + "properties": [], + "specLocation": "_global/bulk/types.ts#L144-L144" }, { "generics": [ { "name": "TDocument", - "namespace": "async_search._types.AsyncSearchDocumentResponseBase" + "namespace": "_global.bulk.UpdateAction" + }, + { + "name": "TPartialDocument", + "namespace": "_global.bulk.UpdateAction" } ], - "inherits": { - "type": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" - } - }, "kind": "interface", "name": { - "name": "AsyncSearchDocumentResponseBase", - "namespace": "async_search._types" + "name": "UpdateAction", + "namespace": "_global.bulk" }, "properties": [ { - "name": "response", - "required": true, + "description": "If true, the `result` in the response is set to 'noop' when no changes to the document occur.", + "name": "detect_noop", + "required": false, + "serverDefault": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearchDocumentResponseBase" - } - } - ], "kind": "instance_of", "type": { - "name": "AsyncSearch", - "namespace": "async_search._types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L50-L54" - }, - { - "kind": "interface", - "name": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" - }, - "properties": [ + }, { - "name": "id", + "description": "A partial update to an existing document.", + "name": "doc", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "TPartialDocument", + "namespace": "_global.bulk.UpdateAction" + } + } + }, + { + "description": "Set to `true` to use the contents of `doc` as the value of `upsert`.", + "name": "doc_as_upsert", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The script to run to update the document.", + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", "namespace": "_types" } } }, { - "description": "When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.\nWhile the query is running, `is_partial` is always set to `true`.", - "name": "is_partial", - "required": true, + "description": "Set to `true` to run the script whether or not the document exists.", + "name": "scripted_upsert", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -107753,305 +101170,273 @@ } }, { - "description": "Indicates whether the search is still running or has completed.\nNOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", - "name": "is_running", - "required": true, + "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "name": "_source", + "required": false, + "serverDefault": "true", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SourceConfig", + "namespace": "_global.search._types" } } }, { - "description": "Indicates when the async search will expire.", - "name": "expiration_time", + "description": "If the document does not already exist, the contents of `upsert` are inserted as a new document.\nIf the document exists, the `script` is run.", + "name": "upsert", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "TDocument", + "namespace": "_global.bulk.UpdateAction" } } - }, + } + ], + "specLocation": "_global/bulk/types.ts#L182-L217" + }, + { + "kind": "interface", + "name": { + "name": "ResponseItem", + "namespace": "_global.bulk" + }, + "properties": [ { - "name": "expiration_time_in_millis", - "required": true, + "description": "The document ID associated with the operation.", + "name": "_id", + "required": false, "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "UnitMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } } ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } + "kind": "union_of" } }, { - "name": "start_time", - "required": false, + "description": "The name of the index associated with the operation.\nIf the operation targeted a data stream, this is the backing index into which the document was written.", + "name": "_index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "start_time_in_millis", + "description": "The HTTP status code returned for the operation.", + "name": "status", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", + "name": "integer", "namespace": "_types" } } }, { - "description": "Indicates when the async search completed. Only present\nwhen the search has completed.", - "name": "completion_time", + "name": "failure_store", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "FailureStoreStatus", + "namespace": "_global.bulk" } } }, { - "name": "completion_time_in_millis", + "description": "Additional information about the failed operation.\nThe property is returned only for failed operations.", + "name": "error", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", + "name": "ErrorCause", "namespace": "_types" } } - } - ], - "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L49" - }, - { - "generics": [ - { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearch" - } - ], - "kind": "interface", - "name": { - "name": "AsyncSearch", - "namespace": "async_search._types" - }, - "properties": [ - { - "description": "Partial aggregations results, coming from the shards that have already completed the execution of the query.", - "name": "aggregations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - } }, { - "name": "_clusters", + "description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.", + "name": "_primary_term", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStatistics", + "name": "long", "namespace": "_types" } } }, { - "name": "fields", + "description": "The result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", + "name": "result", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "hits", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearch" - } - } - ], "kind": "instance_of", "type": { - "name": "HitsMetadata", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_score", + "description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", + "name": "_seq_no", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "SequenceNumber", "namespace": "_types" } } }, { - "description": "Indicates how many reductions of the results have been performed.\nIf this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response.", - "name": "num_reduce_phases", + "description": "Shard information for the operation.", + "name": "_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ShardStatistics", "namespace": "_types" } } }, { - "name": "profile", + "description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.\nThis property is returned only for successful actions.", + "name": "_version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Profile", - "namespace": "_global.search._types" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "name": "pit_id", + "name": "forced_refresh", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "_scroll_id", + "name": "get", "required": false, "type": { + "generics": [ + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + ], "kind": "instance_of", "type": { - "name": "ScrollId", + "name": "InlineGet", "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/bulk/types.ts#L37-L84" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ { - "description": "Indicates how many shards have run the query.\nNote that in order for shard results to be included in the search response, they need to be reduced first.", - "name": "_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardStatistics", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" } + ], + "meta": { + "description": "Document metadata", + "fieldname": "metadata" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" } - }, + } + ], + "generics": [ { - "name": "suggest", + "name": "TDocument", + "namespace": "_types.InlineGet" + } + ], + "kind": "interface", + "name": { + "name": "InlineGet", + "namespace": "_types" + }, + "properties": [ + { + "name": "fields", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "SuggestionName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearch" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Suggest", - "namespace": "_global.search._types" - } - } + "kind": "user_defined_value" } } }, { - "name": "terminated_early", - "required": false, + "name": "found", + "required": true, "type": { "kind": "instance_of", "type": { @@ -108061,19 +101446,19 @@ } }, { - "name": "timed_out", - "required": true, + "name": "_seq_no", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SequenceNumber", + "namespace": "_types" } } }, { - "name": "took", - "required": true, + "name": "_primary_term", + "required": false, "type": { "kind": "instance_of", "type": { @@ -108081,220 +101466,194 @@ "namespace": "_types" } } - } - ], - "specLocation": "async_search/_types/AsyncSearch.ts#L30-L56" - }, - { - "inherits": { - "type": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" - } - }, - "kind": "interface", - "name": { - "name": "StatusResponseBase", - "namespace": "async_search.status" - }, - "properties": [ + }, { - "description": "Indicates how many shards have run the query so far.", - "name": "_shards", - "required": true, + "name": "_routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", + "name": "Routing", "namespace": "_types" } } }, { - "description": "Metadata about clusters involved in the cross-cluster search.\nNot shown for local-only searches.", - "name": "_clusters", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStatistics", - "namespace": "_types" + "name": "TDocument", + "namespace": "_types.InlineGet" } } - }, + } + ], + "specLocation": "_types/common.ts#L324-L337" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "behaviors": [ { - "description": "If the async search completed, this field shows the status code of the search.\nFor example, 200 indicates that the async search was successfully completed.\n503 indicates that the async search was completed with an error.", - "name": "completion_status", - "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "CommonCatQueryParameters", + "namespace": "_spec_utils" } } ], - "specLocation": "async_search/status/AsyncSearchStatusResponse.ts#L24-L38" + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "interface", + "name": { + "name": "CatRequestBase", + "namespace": "cat._types" + }, + "properties": [], + "specLocation": "cat/_types/CatBase.ts#L28-L30" }, { + "description": "Implements a set of common query parameters all Cat API's support.\nSince these can break the request structure these are listed explicitly as a behavior.", "kind": "interface", "name": { - "name": "SlicedScroll", - "namespace": "_types" + "name": "CommonCatQueryParameters", + "namespace": "_spec_utils" }, "properties": [ { - "name": "field", + "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", + "name": "format", "required": false, + "serverDefault": "text", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/SlicedScroll.ts#L23-L27" - }, - { - "kind": "interface", - "name": { - "name": "OperationContainer", - "namespace": "_global.bulk" - }, - "properties": [ - { - "description": "Index the specified document.\nIf the document exists, it replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", - "name": "index", + "description": "List of columns to appear in the response. Supports simple wildcards.", + "name": "h", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexOperation", - "namespace": "_global.bulk" + "name": "Names", + "namespace": "_types" } } }, { - "description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", - "name": "create", + "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", + "name": "help", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "CreateOperation", - "namespace": "_global.bulk" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Perform a partial document update.\nThe following line must contain the partial document and update options.", - "name": "update", + "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", + "name": "s", "required": false, "type": { "kind": "instance_of", "type": { - "name": "UpdateOperation", - "namespace": "_global.bulk" + "name": "Names", + "namespace": "_types" } } }, { - "description": "Remove the specified document from the index.", - "name": "delete", + "description": "When set to `true` will enable verbose output.", + "name": "v", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "DeleteOperation", - "namespace": "_global.bulk" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_global/bulk/types.ts#L158-L180", - "variants": { - "kind": "container" - } - }, - { - "inherits": { - "type": { - "name": "WriteOperation", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "IndexOperation", - "namespace": "_global.bulk" - }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L142-L142" + "specLocation": "_spec_utils/behaviors.ts#L85-L118" }, { - "inherits": { - "type": { - "name": "OperationBase", - "namespace": "_global.bulk" - } - }, "kind": "interface", "name": { - "name": "WriteOperation", - "namespace": "_global.bulk" + "name": "AliasesRecord", + "namespace": "cat.aliases" }, "properties": [ { - "description": "A map from the full name of fields to the name of dynamic templates.\nIt defaults to an empty map.\nIf a name matches a dynamic template, that template will be applied regardless of other match predicates defined in the template.\nIf a field is already defined in the mapping, then this parameter won't be used.", - "name": "dynamic_templates", + "aliases": [ + "a" + ], + "description": "alias name", + "name": "alias", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "i", + "idx" + ], + "description": "index alias points to", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "f", + "fi" + ], + "description": "filter", + "name": "filter", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.", - "name": "pipeline", + "aliases": [ + "ri", + "routingIndex" + ], + "description": "index routing", + "name": "routing.index", "required": false, "type": { "kind": "instance_of", @@ -108305,300 +101664,354 @@ } }, { - "description": "If `true`, the request's actions must target an index alias.", - "name": "require_alias", + "aliases": [ + "rs", + "routingSearch" + ], + "description": "search routing", + "name": "routing.search", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "w", + "isWriteIndex" + ], + "description": "write index", + "name": "is_write_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "_global/bulk/types.ts#L119-L138" + "specLocation": "cat/aliases/types.ts#L22-L53" }, { "kind": "interface", "name": { - "name": "OperationBase", - "namespace": "_global.bulk" + "name": "ComponentTemplate", + "namespace": "cat.component_templates" }, "properties": [ { - "description": "The document ID.", - "name": "_id", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The name of the index or index alias to perform the action on.", - "name": "_index", - "required": false, + "name": "version", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "A custom value used to route operations to a specific shard.", - "name": "routing", - "required": false, + "name": "alias_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "if_primary_term", - "required": false, + "name": "mapping_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "if_seq_no", - "required": false, + "name": "settings_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "version", - "required": false, + "name": "metadata_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "version_type", - "required": false, + "name": "included_in", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionType", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_global/bulk/types.ts#L100-L117" - }, - { - "inherits": { - "type": { - "name": "WriteOperation", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "CreateOperation", - "namespace": "_global.bulk" - }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L140-L140" + "specLocation": "cat/component_templates/types.ts#L20-L28" }, { - "inherits": { - "type": { - "name": "OperationBase", - "namespace": "_global.bulk" - } - }, "kind": "interface", "name": { - "name": "UpdateOperation", - "namespace": "_global.bulk" + "name": "CountRecord", + "namespace": "cat.count" }, "properties": [ { - "description": "If `true`, the request's actions must target an index alias.", - "name": "require_alias", + "aliases": [ + "t", + "time" + ], + "description": "seconds since 1970-01-01 00:00:00", + "name": "epoch", "required": false, - "serverDefault": false, "type": { + "generics": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitSeconds", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "description": "The number of times an update should be retried in the case of a version conflict.", - "name": "retry_on_conflict", + "aliases": [ + "ts", + "hms", + "hhmmss" + ], + "description": "time in HH:MM:SS", + "name": "timestamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "TimeOfDay", "namespace": "_types" } } - } - ], - "specLocation": "_global/bulk/types.ts#L146-L156" - }, - { - "inherits": { - "type": { - "name": "OperationBase", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "DeleteOperation", - "namespace": "_global.bulk" - }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L144-L144" - }, - { - "generics": [ - { - "name": "TDocument", - "namespace": "_global.bulk.UpdateAction" }, { - "name": "TPartialDocument", - "namespace": "_global.bulk.UpdateAction" + "aliases": [ + "dc", + "docs.count", + "docsCount" + ], + "description": "the document count", + "name": "count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], + "specLocation": "cat/count/types.ts#L23-L39" + }, + { "kind": "interface", "name": { - "name": "UpdateAction", - "namespace": "_global.bulk" + "name": "IndicesRecord", + "namespace": "cat.indices" }, "properties": [ { - "description": "If true, the `result` in the response is set to 'noop' when no changes to the document occur.", - "name": "detect_noop", + "aliases": [ + "h" + ], + "description": "current health status", + "name": "health", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "A partial update to an existing document.", - "name": "doc", + "aliases": [ + "s" + ], + "description": "open/close status", + "name": "status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TPartialDocument", - "namespace": "_global.bulk.UpdateAction" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Set to `true` to use the contents of `doc` as the value of `upsert`.", - "name": "doc_as_upsert", + "aliases": [ + "i", + "idx" + ], + "description": "index name", + "name": "index", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The script to run to update the document.", - "name": "script", + "aliases": [ + "id" + ], + "description": "index uuid", + "name": "uuid", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Set to `true` to run the script whether or not the document exists.", - "name": "scripted_upsert", + "aliases": [ + "p", + "shards.primary", + "shardsPrimary" + ], + "description": "number of primary shards", + "name": "pri", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.", - "name": "_source", + "aliases": [ + "r", + "shards.replica", + "shardsReplica" + ], + "description": "number of replica shards", + "name": "rep", "required": false, - "serverDefault": "true", "type": { "kind": "instance_of", "type": { - "name": "SourceConfig", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If the document does not already exist, the contents of `upsert` are inserted as a new document.\nIf the document exists, the `script` is run.", - "name": "upsert", + "aliases": [ + "dc", + "docsCount" + ], + "description": "available docs", + "name": "docs.count", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.bulk.UpdateAction" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } - } - ], - "specLocation": "_global/bulk/types.ts#L182-L217" - }, - { - "kind": "interface", - "name": { - "name": "ResponseItem", - "namespace": "_global.bulk" - }, - "properties": [ + }, { - "description": "The document ID associated with the operation.", - "name": "_id", + "aliases": [ + "dd", + "docsDeleted" + ], + "description": "deleted docs", + "name": "docs.deleted", "required": false, "type": { "items": [ @@ -108621,9 +102034,12 @@ } }, { - "description": "The name of the index associated with the operation.\nIf the operation targeted a data stream, this is the backing index into which the document was written.", - "name": "_index", - "required": true, + "aliases": [ + "cd" + ], + "description": "index creation date (millisecond value)", + "name": "creation.date", + "required": false, "type": { "kind": "instance_of", "type": { @@ -108633,55 +102049,113 @@ } }, { - "description": "The HTTP status code returned for the operation.", - "name": "status", - "required": true, + "aliases": [ + "cds" + ], + "description": "index creation date (as string)", + "name": "creation.date.string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "failure_store", + "aliases": [ + "ss", + "storeSize" + ], + "description": "store size of primaries & replicas", + "name": "store.size", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "FailureStoreStatus", - "namespace": "_global.bulk" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "Additional information about the failed operation.\nThe property is returned only for failed operations.", - "name": "error", + "description": "store size of primaries", + "name": "pri.store.size", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "ErrorCause", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.", - "name": "_primary_term", + "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "description": "total size of dataset (including the cache for partially mounted indices)", + "name": "dataset.size", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "The result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", - "name": "result", + "aliases": [ + "cs", + "completionSize" + ], + "description": "size of completion", + "name": "completion.size", "required": false, "type": { "kind": "instance_of", @@ -108692,238 +102166,177 @@ } }, { - "description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", - "name": "_seq_no", + "description": "size of completion", + "name": "pri.completion.size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Shard information for the operation.", - "name": "_shards", + "aliases": [ + "fm", + "fielddataMemory" + ], + "description": "used fielddata cache", + "name": "fielddata.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.\nThis property is returned only for successful actions.", - "name": "_version", + "description": "used fielddata cache", + "name": "pri.fielddata.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "forced_refresh", + "aliases": [ + "fe", + "fielddataEvictions" + ], + "description": "fielddata evictions", + "name": "fielddata.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "get", + "description": "fielddata evictions", + "name": "pri.fielddata.evictions", "required": false, "type": { - "generics": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - ], "kind": "instance_of", "type": { - "name": "InlineGet", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_global/bulk/types.ts#L37-L84" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "user_defined_value" - } + "aliases": [ + "qcm", + "queryCacheMemory" ], - "meta": { - "description": "Document metadata", - "fieldname": "metadata" - }, - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } - } - ], - "generics": [ - { - "name": "TDocument", - "namespace": "_types.InlineGet" - } - ], - "kind": "interface", - "name": { - "name": "InlineGet", - "namespace": "_types" - }, - "properties": [ - { - "name": "fields", + "description": "used query cache", + "name": "query_cache.memory_size", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "found", - "required": true, + "description": "used query cache", + "name": "pri.query_cache.memory_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "_seq_no", + "aliases": [ + "qce", + "queryCacheEvictions" + ], + "description": "query cache evictions", + "name": "query_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_primary_term", + "description": "query cache evictions", + "name": "pri.query_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_routing", + "aliases": [ + "rcm", + "requestCacheMemory" + ], + "description": "used request cache", + "name": "request_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_source", + "description": "used request cache", + "name": "pri.request_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "_types.InlineGet" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/common.ts#L324-L337" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "behaviors": [ + }, { + "aliases": [ + "rce", + "requestCacheEvictions" + ], + "description": "request cache evictions", + "name": "request_cache.evictions", + "required": false, "type": { - "name": "CommonCatQueryParameters", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - ], - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "interface", - "name": { - "name": "CatRequestBase", - "namespace": "cat._types" - }, - "properties": [], - "specLocation": "cat/_types/CatBase.ts#L28-L30" - }, - { - "description": "Implements a set of common query parameters all Cat API's support.\nSince these can break the request structure these are listed explicitly as a behavior.", - "kind": "interface", - "name": { - "name": "CommonCatQueryParameters", - "namespace": "_spec_utils" - }, - "properties": [ + }, { - "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", - "name": "format", + "description": "request cache evictions", + "name": "pri.request_cache.evictions", "required": false, - "serverDefault": "text", "type": { "kind": "instance_of", "type": { @@ -108933,71 +102346,68 @@ } }, { - "description": "List of columns to appear in the response. Supports simple wildcards.", - "name": "h", + "aliases": [ + "rchc", + "requestCacheHitCount" + ], + "description": "request cache hit count", + "name": "request_cache.hit_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", - "name": "help", + "description": "request cache hit count", + "name": "pri.request_cache.hit_count", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", - "name": "s", + "aliases": [ + "rcmc", + "requestCacheMissCount" + ], + "description": "request cache miss count", + "name": "request_cache.miss_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "When set to `true` will enable verbose output.", - "name": "v", + "description": "request cache miss count", + "name": "pri.request_cache.miss_count", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "_spec_utils/behaviors.ts#L85-L118" - }, - { - "kind": "interface", - "name": { - "name": "AliasesRecord", - "namespace": "cat.aliases" - }, - "properties": [ + }, { "aliases": [ - "a" + "ft", + "flushTotal" ], - "description": "alias name", - "name": "alias", + "description": "number of flushes", + "name": "flush.total", "required": false, "type": { "kind": "instance_of", @@ -109008,28 +102418,24 @@ } }, { - "aliases": [ - "i", - "idx" - ], - "description": "index alias points to", - "name": "index", + "description": "number of flushes", + "name": "pri.flush.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "f", - "fi" + "ftt", + "flushTotalTime" ], - "description": "filter", - "name": "filter", + "description": "time spent in flush", + "name": "flush.total_time", "required": false, "type": { "kind": "instance_of", @@ -109040,12 +102446,8 @@ } }, { - "aliases": [ - "ri", - "routingIndex" - ], - "description": "index routing", - "name": "routing.index", + "description": "time spent in flush", + "name": "pri.flush.total_time", "required": false, "type": { "kind": "instance_of", @@ -109057,11 +102459,11 @@ }, { "aliases": [ - "rs", - "routingSearch" + "gc", + "getCurrent" ], - "description": "search routing", - "name": "routing.search", + "description": "number of current get ops", + "name": "get.current", "required": false, "type": { "kind": "instance_of", @@ -109072,12 +102474,8 @@ } }, { - "aliases": [ - "w", - "isWriteIndex" - ], - "description": "write index", - "name": "is_write_index", + "description": "number of current get ops", + "name": "pri.get.current", "required": false, "type": { "kind": "instance_of", @@ -109086,20 +102484,15 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/aliases/types.ts#L22-L53" - }, - { - "kind": "interface", - "name": { - "name": "ComponentTemplate", - "namespace": "cat.component_templates" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "aliases": [ + "gti", + "getTime" + ], + "description": "time spent in get", + "name": "get.time", + "required": false, "type": { "kind": "instance_of", "type": { @@ -109109,31 +102502,25 @@ } }, { - "name": "version", - "required": true, + "description": "time spent in get", + "name": "pri.get.time", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "alias_count", - "required": true, + "aliases": [ + "gto", + "getTotal" + ], + "description": "number of get ops", + "name": "get.total", + "required": false, "type": { "kind": "instance_of", "type": { @@ -109143,8 +102530,9 @@ } }, { - "name": "mapping_count", - "required": true, + "description": "number of get ops", + "name": "pri.get.total", + "required": false, "type": { "kind": "instance_of", "type": { @@ -109154,8 +102542,13 @@ } }, { - "name": "settings_count", - "required": true, + "aliases": [ + "geti", + "getExistsTime" + ], + "description": "time spent in successful gets", + "name": "get.exists_time", + "required": false, "type": { "kind": "instance_of", "type": { @@ -109165,8 +102558,9 @@ } }, { - "name": "metadata_count", - "required": true, + "description": "time spent in successful gets", + "name": "pri.get.exists_time", + "required": false, "type": { "kind": "instance_of", "type": { @@ -109176,8 +102570,13 @@ } }, { - "name": "included_in", - "required": true, + "aliases": [ + "geto", + "getExistsTotal" + ], + "description": "number of successful gets", + "name": "get.exists_total", + "required": false, "type": { "kind": "instance_of", "type": { @@ -109185,76 +102584,38 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/component_templates/types.ts#L20-L28" - }, - { - "kind": "interface", - "name": { - "name": "CountRecord", - "namespace": "cat.count" - }, - "properties": [ + }, { - "aliases": [ - "t", - "time" - ], - "description": "seconds since 1970-01-01 00:00:00", - "name": "epoch", + "description": "number of successful gets", + "name": "pri.get.exists_total", "required": false, "type": { - "generics": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitSeconds", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ts", - "hms", - "hhmmss" + "gmti", + "getMissingTime" ], - "description": "time in HH:MM:SS", - "name": "timestamp", + "description": "time spent in failed gets", + "name": "get.missing_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeOfDay", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "dc", - "docs.count", - "docsCount" - ], - "description": "the document count", - "name": "count", + "description": "time spent in failed gets", + "name": "pri.get.missing_time", "required": false, "type": { "kind": "instance_of", @@ -109263,23 +102624,14 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/count/types.ts#L23-L39" - }, - { - "kind": "interface", - "name": { - "name": "IndicesRecord", - "namespace": "cat.indices" - }, - "properties": [ + }, { "aliases": [ - "h" + "gmto", + "getMissingTotal" ], - "description": "current health status", - "name": "health", + "description": "number of failed gets", + "name": "get.missing_total", "required": false, "type": { "kind": "instance_of", @@ -109290,11 +102642,8 @@ } }, { - "aliases": [ - "s" - ], - "description": "open/close status", - "name": "status", + "description": "number of failed gets", + "name": "pri.get.missing_total", "required": false, "type": { "kind": "instance_of", @@ -109306,11 +102655,11 @@ }, { "aliases": [ - "i", - "idx" + "idc", + "indexingDeleteCurrent" ], - "description": "index name", - "name": "index", + "description": "number of current deletions", + "name": "indexing.delete_current", "required": false, "type": { "kind": "instance_of", @@ -109321,11 +102670,8 @@ } }, { - "aliases": [ - "id" - ], - "description": "index uuid", - "name": "uuid", + "description": "number of current deletions", + "name": "pri.indexing.delete_current", "required": false, "type": { "kind": "instance_of", @@ -109337,12 +102683,11 @@ }, { "aliases": [ - "p", - "shards.primary", - "shardsPrimary" + "idti", + "indexingDeleteTime" ], - "description": "number of primary shards", - "name": "pri", + "description": "time spent in deletions", + "name": "indexing.delete_time", "required": false, "type": { "kind": "instance_of", @@ -109353,13 +102698,8 @@ } }, { - "aliases": [ - "r", - "shards.replica", - "shardsReplica" - ], - "description": "number of replica shards", - "name": "rep", + "description": "time spent in deletions", + "name": "pri.indexing.delete_time", "required": false, "type": { "kind": "instance_of", @@ -109371,66 +102711,39 @@ }, { "aliases": [ - "dc", - "docsCount" + "idto", + "indexingDeleteTotal" ], - "description": "available docs", - "name": "docs.count", + "description": "number of delete ops", + "name": "indexing.delete_total", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "aliases": [ - "dd", - "docsDeleted" - ], - "description": "deleted docs", - "name": "docs.deleted", + "description": "number of delete ops", + "name": "pri.indexing.delete_total", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { "aliases": [ - "cd" + "iic", + "indexingIndexCurrent" ], - "description": "index creation date (millisecond value)", - "name": "creation.date", + "description": "number of current indexing ops", + "name": "indexing.index_current", "required": false, "type": { "kind": "instance_of", @@ -109441,11 +102754,8 @@ } }, { - "aliases": [ - "cds" - ], - "description": "index creation date (as string)", - "name": "creation.date.string", + "description": "number of current indexing ops", + "name": "pri.indexing.index_current", "required": false, "type": { "kind": "instance_of", @@ -109457,97 +102767,39 @@ }, { "aliases": [ - "ss", - "storeSize" + "iiti", + "indexingIndexTime" ], - "description": "store size of primaries & replicas", - "name": "store.size", + "description": "time spent in indexing", + "name": "indexing.index_time", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "description": "store size of primaries", - "name": "pri.store.size", + "description": "time spent in indexing", + "name": "pri.indexing.index_time", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - }, - "description": "total size of dataset (including the cache for partially mounted indices)", - "name": "dataset.size", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" } }, { "aliases": [ - "cs", - "completionSize" + "iito", + "indexingIndexTotal" ], - "description": "size of completion", - "name": "completion.size", + "description": "number of indexing ops", + "name": "indexing.index_total", "required": false, "type": { "kind": "instance_of", @@ -109558,8 +102810,8 @@ } }, { - "description": "size of completion", - "name": "pri.completion.size", + "description": "number of indexing ops", + "name": "pri.indexing.index_total", "required": false, "type": { "kind": "instance_of", @@ -109571,11 +102823,11 @@ }, { "aliases": [ - "fm", - "fielddataMemory" + "iif", + "indexingIndexFailed" ], - "description": "used fielddata cache", - "name": "fielddata.memory_size", + "description": "number of failed indexing ops", + "name": "indexing.index_failed", "required": false, "type": { "kind": "instance_of", @@ -109586,8 +102838,8 @@ } }, { - "description": "used fielddata cache", - "name": "pri.fielddata.memory_size", + "description": "number of failed indexing ops", + "name": "pri.indexing.index_failed", "required": false, "type": { "kind": "instance_of", @@ -109599,11 +102851,11 @@ }, { "aliases": [ - "fe", - "fielddataEvictions" + "mc", + "mergesCurrent" ], - "description": "fielddata evictions", - "name": "fielddata.evictions", + "description": "number of current merges", + "name": "merges.current", "required": false, "type": { "kind": "instance_of", @@ -109614,8 +102866,8 @@ } }, { - "description": "fielddata evictions", - "name": "pri.fielddata.evictions", + "description": "number of current merges", + "name": "pri.merges.current", "required": false, "type": { "kind": "instance_of", @@ -109627,11 +102879,11 @@ }, { "aliases": [ - "qcm", - "queryCacheMemory" + "mcd", + "mergesCurrentDocs" ], - "description": "used query cache", - "name": "query_cache.memory_size", + "description": "number of current merging docs", + "name": "merges.current_docs", "required": false, "type": { "kind": "instance_of", @@ -109642,8 +102894,8 @@ } }, { - "description": "used query cache", - "name": "pri.query_cache.memory_size", + "description": "number of current merging docs", + "name": "pri.merges.current_docs", "required": false, "type": { "kind": "instance_of", @@ -109655,11 +102907,11 @@ }, { "aliases": [ - "qce", - "queryCacheEvictions" + "mcs", + "mergesCurrentSize" ], - "description": "query cache evictions", - "name": "query_cache.evictions", + "description": "size of current merges", + "name": "merges.current_size", "required": false, "type": { "kind": "instance_of", @@ -109670,8 +102922,8 @@ } }, { - "description": "query cache evictions", - "name": "pri.query_cache.evictions", + "description": "size of current merges", + "name": "pri.merges.current_size", "required": false, "type": { "kind": "instance_of", @@ -109683,11 +102935,11 @@ }, { "aliases": [ - "rcm", - "requestCacheMemory" + "mt", + "mergesTotal" ], - "description": "used request cache", - "name": "request_cache.memory_size", + "description": "number of completed merge ops", + "name": "merges.total", "required": false, "type": { "kind": "instance_of", @@ -109698,8 +102950,8 @@ } }, { - "description": "used request cache", - "name": "pri.request_cache.memory_size", + "description": "number of completed merge ops", + "name": "pri.merges.total", "required": false, "type": { "kind": "instance_of", @@ -109711,11 +102963,11 @@ }, { "aliases": [ - "rce", - "requestCacheEvictions" + "mtd", + "mergesTotalDocs" ], - "description": "request cache evictions", - "name": "request_cache.evictions", + "description": "docs merged", + "name": "merges.total_docs", "required": false, "type": { "kind": "instance_of", @@ -109726,8 +102978,8 @@ } }, { - "description": "request cache evictions", - "name": "pri.request_cache.evictions", + "description": "docs merged", + "name": "pri.merges.total_docs", "required": false, "type": { "kind": "instance_of", @@ -109739,11 +102991,11 @@ }, { "aliases": [ - "rchc", - "requestCacheHitCount" + "mts", + "mergesTotalSize" ], - "description": "request cache hit count", - "name": "request_cache.hit_count", + "description": "size merged", + "name": "merges.total_size", "required": false, "type": { "kind": "instance_of", @@ -109754,8 +103006,8 @@ } }, { - "description": "request cache hit count", - "name": "pri.request_cache.hit_count", + "description": "size merged", + "name": "pri.merges.total_size", "required": false, "type": { "kind": "instance_of", @@ -109767,11 +103019,11 @@ }, { "aliases": [ - "rcmc", - "requestCacheMissCount" + "mtt", + "mergesTotalTime" ], - "description": "request cache miss count", - "name": "request_cache.miss_count", + "description": "time spent in merges", + "name": "merges.total_time", "required": false, "type": { "kind": "instance_of", @@ -109782,8 +103034,8 @@ } }, { - "description": "request cache miss count", - "name": "pri.request_cache.miss_count", + "description": "time spent in merges", + "name": "pri.merges.total_time", "required": false, "type": { "kind": "instance_of", @@ -109795,11 +103047,11 @@ }, { "aliases": [ - "ft", - "flushTotal" + "rto", + "refreshTotal" ], - "description": "number of flushes", - "name": "flush.total", + "description": "total refreshes", + "name": "refresh.total", "required": false, "type": { "kind": "instance_of", @@ -109810,8 +103062,8 @@ } }, { - "description": "number of flushes", - "name": "pri.flush.total", + "description": "total refreshes", + "name": "pri.refresh.total", "required": false, "type": { "kind": "instance_of", @@ -109823,11 +103075,11 @@ }, { "aliases": [ - "ftt", - "flushTotalTime" + "rti", + "refreshTime" ], - "description": "time spent in flush", - "name": "flush.total_time", + "description": "time spent in refreshes", + "name": "refresh.time", "required": false, "type": { "kind": "instance_of", @@ -109838,8 +103090,8 @@ } }, { - "description": "time spent in flush", - "name": "pri.flush.total_time", + "description": "time spent in refreshes", + "name": "pri.refresh.time", "required": false, "type": { "kind": "instance_of", @@ -109851,11 +103103,10 @@ }, { "aliases": [ - "gc", - "getCurrent" + "reto" ], - "description": "number of current get ops", - "name": "get.current", + "description": "total external refreshes", + "name": "refresh.external_total", "required": false, "type": { "kind": "instance_of", @@ -109866,8 +103117,8 @@ } }, { - "description": "number of current get ops", - "name": "pri.get.current", + "description": "total external refreshes", + "name": "pri.refresh.external_total", "required": false, "type": { "kind": "instance_of", @@ -109879,11 +103130,10 @@ }, { "aliases": [ - "gti", - "getTime" + "reti" ], - "description": "time spent in get", - "name": "get.time", + "description": "time spent in external refreshes", + "name": "refresh.external_time", "required": false, "type": { "kind": "instance_of", @@ -109894,8 +103144,8 @@ } }, { - "description": "time spent in get", - "name": "pri.get.time", + "description": "time spent in external refreshes", + "name": "pri.refresh.external_time", "required": false, "type": { "kind": "instance_of", @@ -109907,11 +103157,11 @@ }, { "aliases": [ - "gto", - "getTotal" + "rli", + "refreshListeners" ], - "description": "number of get ops", - "name": "get.total", + "description": "number of pending refresh listeners", + "name": "refresh.listeners", "required": false, "type": { "kind": "instance_of", @@ -109922,8 +103172,8 @@ } }, { - "description": "number of get ops", - "name": "pri.get.total", + "description": "number of pending refresh listeners", + "name": "pri.refresh.listeners", "required": false, "type": { "kind": "instance_of", @@ -109935,11 +103185,11 @@ }, { "aliases": [ - "geti", - "getExistsTime" + "sfc", + "searchFetchCurrent" ], - "description": "time spent in successful gets", - "name": "get.exists_time", + "description": "current fetch phase ops", + "name": "search.fetch_current", "required": false, "type": { "kind": "instance_of", @@ -109950,8 +103200,8 @@ } }, { - "description": "time spent in successful gets", - "name": "pri.get.exists_time", + "description": "current fetch phase ops", + "name": "pri.search.fetch_current", "required": false, "type": { "kind": "instance_of", @@ -109963,11 +103213,11 @@ }, { "aliases": [ - "geto", - "getExistsTotal" + "sfti", + "searchFetchTime" ], - "description": "number of successful gets", - "name": "get.exists_total", + "description": "time spent in fetch phase", + "name": "search.fetch_time", "required": false, "type": { "kind": "instance_of", @@ -109978,8 +103228,8 @@ } }, { - "description": "number of successful gets", - "name": "pri.get.exists_total", + "description": "time spent in fetch phase", + "name": "pri.search.fetch_time", "required": false, "type": { "kind": "instance_of", @@ -109991,11 +103241,11 @@ }, { "aliases": [ - "gmti", - "getMissingTime" + "sfto", + "searchFetchTotal" ], - "description": "time spent in failed gets", - "name": "get.missing_time", + "description": "total fetch ops", + "name": "search.fetch_total", "required": false, "type": { "kind": "instance_of", @@ -110006,8 +103256,8 @@ } }, { - "description": "time spent in failed gets", - "name": "pri.get.missing_time", + "description": "total fetch ops", + "name": "pri.search.fetch_total", "required": false, "type": { "kind": "instance_of", @@ -110019,11 +103269,11 @@ }, { "aliases": [ - "gmto", - "getMissingTotal" + "so", + "searchOpenContexts" ], - "description": "number of failed gets", - "name": "get.missing_total", + "description": "open search contexts", + "name": "search.open_contexts", "required": false, "type": { "kind": "instance_of", @@ -110034,8 +103284,8 @@ } }, { - "description": "number of failed gets", - "name": "pri.get.missing_total", + "description": "open search contexts", + "name": "pri.search.open_contexts", "required": false, "type": { "kind": "instance_of", @@ -110047,11 +103297,11 @@ }, { "aliases": [ - "idc", - "indexingDeleteCurrent" + "sqc", + "searchQueryCurrent" ], - "description": "number of current deletions", - "name": "indexing.delete_current", + "description": "current query phase ops", + "name": "search.query_current", "required": false, "type": { "kind": "instance_of", @@ -110062,8 +103312,8 @@ } }, { - "description": "number of current deletions", - "name": "pri.indexing.delete_current", + "description": "current query phase ops", + "name": "pri.search.query_current", "required": false, "type": { "kind": "instance_of", @@ -110075,11 +103325,11 @@ }, { "aliases": [ - "idti", - "indexingDeleteTime" + "sqti", + "searchQueryTime" ], - "description": "time spent in deletions", - "name": "indexing.delete_time", + "description": "time spent in query phase", + "name": "search.query_time", "required": false, "type": { "kind": "instance_of", @@ -110090,8 +103340,8 @@ } }, { - "description": "time spent in deletions", - "name": "pri.indexing.delete_time", + "description": "time spent in query phase", + "name": "pri.search.query_time", "required": false, "type": { "kind": "instance_of", @@ -110103,11 +103353,11 @@ }, { "aliases": [ - "idto", - "indexingDeleteTotal" + "sqto", + "searchQueryTotal" ], - "description": "number of delete ops", - "name": "indexing.delete_total", + "description": "total query phase ops", + "name": "search.query_total", "required": false, "type": { "kind": "instance_of", @@ -110118,8 +103368,8 @@ } }, { - "description": "number of delete ops", - "name": "pri.indexing.delete_total", + "description": "total query phase ops", + "name": "pri.search.query_total", "required": false, "type": { "kind": "instance_of", @@ -110131,11 +103381,11 @@ }, { "aliases": [ - "iic", - "indexingIndexCurrent" + "scc", + "searchScrollCurrent" ], - "description": "number of current indexing ops", - "name": "indexing.index_current", + "description": "open scroll contexts", + "name": "search.scroll_current", "required": false, "type": { "kind": "instance_of", @@ -110146,8 +103396,8 @@ } }, { - "description": "number of current indexing ops", - "name": "pri.indexing.index_current", + "description": "open scroll contexts", + "name": "pri.search.scroll_current", "required": false, "type": { "kind": "instance_of", @@ -110159,11 +103409,11 @@ }, { "aliases": [ - "iiti", - "indexingIndexTime" + "scti", + "searchScrollTime" ], - "description": "time spent in indexing", - "name": "indexing.index_time", + "description": "time scroll contexts held open", + "name": "search.scroll_time", "required": false, "type": { "kind": "instance_of", @@ -110174,8 +103424,8 @@ } }, { - "description": "time spent in indexing", - "name": "pri.indexing.index_time", + "description": "time scroll contexts held open", + "name": "pri.search.scroll_time", "required": false, "type": { "kind": "instance_of", @@ -110187,11 +103437,11 @@ }, { "aliases": [ - "iito", - "indexingIndexTotal" + "scto", + "searchScrollTotal" ], - "description": "number of indexing ops", - "name": "indexing.index_total", + "description": "completed scroll contexts", + "name": "search.scroll_total", "required": false, "type": { "kind": "instance_of", @@ -110202,8 +103452,8 @@ } }, { - "description": "number of indexing ops", - "name": "pri.indexing.index_total", + "description": "completed scroll contexts", + "name": "pri.search.scroll_total", "required": false, "type": { "kind": "instance_of", @@ -110215,11 +103465,11 @@ }, { "aliases": [ - "iif", - "indexingIndexFailed" + "sc", + "segmentsCount" ], - "description": "number of failed indexing ops", - "name": "indexing.index_failed", + "description": "number of segments", + "name": "segments.count", "required": false, "type": { "kind": "instance_of", @@ -110230,8 +103480,8 @@ } }, { - "description": "number of failed indexing ops", - "name": "pri.indexing.index_failed", + "description": "number of segments", + "name": "pri.segments.count", "required": false, "type": { "kind": "instance_of", @@ -110243,11 +103493,11 @@ }, { "aliases": [ - "mc", - "mergesCurrent" + "sm", + "segmentsMemory" ], - "description": "number of current merges", - "name": "merges.current", + "description": "memory used by segments", + "name": "segments.memory", "required": false, "type": { "kind": "instance_of", @@ -110258,8 +103508,8 @@ } }, { - "description": "number of current merges", - "name": "pri.merges.current", + "description": "memory used by segments", + "name": "pri.segments.memory", "required": false, "type": { "kind": "instance_of", @@ -110271,11 +103521,11 @@ }, { "aliases": [ - "mcd", - "mergesCurrentDocs" + "siwm", + "segmentsIndexWriterMemory" ], - "description": "number of current merging docs", - "name": "merges.current_docs", + "description": "memory used by index writer", + "name": "segments.index_writer_memory", "required": false, "type": { "kind": "instance_of", @@ -110286,8 +103536,8 @@ } }, { - "description": "number of current merging docs", - "name": "pri.merges.current_docs", + "description": "memory used by index writer", + "name": "pri.segments.index_writer_memory", "required": false, "type": { "kind": "instance_of", @@ -110299,11 +103549,11 @@ }, { "aliases": [ - "mcs", - "mergesCurrentSize" + "svmm", + "segmentsVersionMapMemory" ], - "description": "size of current merges", - "name": "merges.current_size", + "description": "memory used by version map", + "name": "segments.version_map_memory", "required": false, "type": { "kind": "instance_of", @@ -110314,8 +103564,8 @@ } }, { - "description": "size of current merges", - "name": "pri.merges.current_size", + "description": "memory used by version map", + "name": "pri.segments.version_map_memory", "required": false, "type": { "kind": "instance_of", @@ -110327,11 +103577,11 @@ }, { "aliases": [ - "mt", - "mergesTotal" + "sfbm", + "fixedBitsetMemory" ], - "description": "number of completed merge ops", - "name": "merges.total", + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "segments.fixed_bitset_memory", "required": false, "type": { "kind": "instance_of", @@ -110342,8 +103592,8 @@ } }, { - "description": "number of completed merge ops", - "name": "pri.merges.total", + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "pri.segments.fixed_bitset_memory", "required": false, "type": { "kind": "instance_of", @@ -110355,11 +103605,11 @@ }, { "aliases": [ - "mtd", - "mergesTotalDocs" + "wc", + "warmerCurrent" ], - "description": "docs merged", - "name": "merges.total_docs", + "description": "current warmer ops", + "name": "warmer.current", "required": false, "type": { "kind": "instance_of", @@ -110370,8 +103620,8 @@ } }, { - "description": "docs merged", - "name": "pri.merges.total_docs", + "description": "current warmer ops", + "name": "pri.warmer.current", "required": false, "type": { "kind": "instance_of", @@ -110383,11 +103633,11 @@ }, { "aliases": [ - "mts", - "mergesTotalSize" + "wto", + "warmerTotal" ], - "description": "size merged", - "name": "merges.total_size", + "description": "total warmer ops", + "name": "warmer.total", "required": false, "type": { "kind": "instance_of", @@ -110398,8 +103648,8 @@ } }, { - "description": "size merged", - "name": "pri.merges.total_size", + "description": "total warmer ops", + "name": "pri.warmer.total", "required": false, "type": { "kind": "instance_of", @@ -110411,11 +103661,11 @@ }, { "aliases": [ - "mtt", - "mergesTotalTime" + "wtt", + "warmerTotalTime" ], - "description": "time spent in merges", - "name": "merges.total_time", + "description": "time spent in warmers", + "name": "warmer.total_time", "required": false, "type": { "kind": "instance_of", @@ -110426,8 +103676,8 @@ } }, { - "description": "time spent in merges", - "name": "pri.merges.total_time", + "description": "time spent in warmers", + "name": "pri.warmer.total_time", "required": false, "type": { "kind": "instance_of", @@ -110439,11 +103689,11 @@ }, { "aliases": [ - "rto", - "refreshTotal" + "suc", + "suggestCurrent" ], - "description": "total refreshes", - "name": "refresh.total", + "description": "number of current suggest ops", + "name": "suggest.current", "required": false, "type": { "kind": "instance_of", @@ -110454,8 +103704,8 @@ } }, { - "description": "total refreshes", - "name": "pri.refresh.total", + "description": "number of current suggest ops", + "name": "pri.suggest.current", "required": false, "type": { "kind": "instance_of", @@ -110467,11 +103717,11 @@ }, { "aliases": [ - "rti", - "refreshTime" + "suti", + "suggestTime" ], - "description": "time spent in refreshes", - "name": "refresh.time", + "description": "time spend in suggest", + "name": "suggest.time", "required": false, "type": { "kind": "instance_of", @@ -110482,8 +103732,8 @@ } }, { - "description": "time spent in refreshes", - "name": "pri.refresh.time", + "description": "time spend in suggest", + "name": "pri.suggest.time", "required": false, "type": { "kind": "instance_of", @@ -110495,10 +103745,11 @@ }, { "aliases": [ - "reto" + "suto", + "suggestTotal" ], - "description": "total external refreshes", - "name": "refresh.external_total", + "description": "number of suggest ops", + "name": "suggest.total", "required": false, "type": { "kind": "instance_of", @@ -110509,8 +103760,8 @@ } }, { - "description": "total external refreshes", - "name": "pri.refresh.external_total", + "description": "number of suggest ops", + "name": "pri.suggest.total", "required": false, "type": { "kind": "instance_of", @@ -110522,10 +103773,11 @@ }, { "aliases": [ - "reti" + "tm", + "memoryTotal" ], - "description": "time spent in external refreshes", - "name": "refresh.external_time", + "description": "total used memory", + "name": "memory.total", "required": false, "type": { "kind": "instance_of", @@ -110536,8 +103788,8 @@ } }, { - "description": "time spent in external refreshes", - "name": "pri.refresh.external_time", + "description": "total user memory", + "name": "pri.memory.total", "required": false, "type": { "kind": "instance_of", @@ -110549,23 +103801,10 @@ }, { "aliases": [ - "rli", - "refreshListeners" + "sth" ], - "description": "number of pending refresh listeners", - "name": "refresh.listeners", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "number of pending refresh listeners", - "name": "pri.refresh.listeners", + "description": "indicates if the index is search throttled", + "name": "search.throttled", "required": false, "type": { "kind": "instance_of", @@ -110577,11 +103816,11 @@ }, { "aliases": [ - "sfc", - "searchFetchCurrent" + "bto", + "bulkTotalOperation" ], - "description": "current fetch phase ops", - "name": "search.fetch_current", + "description": "number of bulk shard ops", + "name": "bulk.total_operations", "required": false, "type": { "kind": "instance_of", @@ -110592,8 +103831,8 @@ } }, { - "description": "current fetch phase ops", - "name": "pri.search.fetch_current", + "description": "number of bulk shard ops", + "name": "pri.bulk.total_operations", "required": false, "type": { "kind": "instance_of", @@ -110605,11 +103844,11 @@ }, { "aliases": [ - "sfti", - "searchFetchTime" + "btti", + "bulkTotalTime" ], - "description": "time spent in fetch phase", - "name": "search.fetch_time", + "description": "time spend in shard bulk", + "name": "bulk.total_time", "required": false, "type": { "kind": "instance_of", @@ -110620,8 +103859,8 @@ } }, { - "description": "time spent in fetch phase", - "name": "pri.search.fetch_time", + "description": "time spend in shard bulk", + "name": "pri.bulk.total_time", "required": false, "type": { "kind": "instance_of", @@ -110633,11 +103872,11 @@ }, { "aliases": [ - "sfto", - "searchFetchTotal" + "btsi", + "bulkTotalSizeInBytes" ], - "description": "total fetch ops", - "name": "search.fetch_total", + "description": "total size in bytes of shard bulk", + "name": "bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -110648,8 +103887,8 @@ } }, { - "description": "total fetch ops", - "name": "pri.search.fetch_total", + "description": "total size in bytes of shard bulk", + "name": "pri.bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -110661,11 +103900,11 @@ }, { "aliases": [ - "so", - "searchOpenContexts" + "bati", + "bulkAvgTime" ], - "description": "open search contexts", - "name": "search.open_contexts", + "description": "average time spend in shard bulk", + "name": "bulk.avg_time", "required": false, "type": { "kind": "instance_of", @@ -110676,8 +103915,8 @@ } }, { - "description": "open search contexts", - "name": "pri.search.open_contexts", + "description": "average time spend in shard bulk", + "name": "pri.bulk.avg_time", "required": false, "type": { "kind": "instance_of", @@ -110689,11 +103928,11 @@ }, { "aliases": [ - "sqc", - "searchQueryCurrent" + "basi", + "bulkAvgSizeInBytes" ], - "description": "current query phase ops", - "name": "search.query_current", + "description": "average size in bytes of shard bulk", + "name": "bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -110704,8 +103943,8 @@ } }, { - "description": "current query phase ops", - "name": "pri.search.query_current", + "description": "average size in bytes of shard bulk", + "name": "pri.bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -110714,14 +103953,35 @@ "namespace": "_builtins" } } + } + ], + "specLocation": "cat/indices/types.ts#L20-L808" + }, + { + "kind": "interface", + "name": { + "name": "DataFrameAnalyticsRecord", + "namespace": "cat.ml_data_frame_analytics" + }, + "properties": [ + { + "description": "The identifier for the job.", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } }, { "aliases": [ - "sqti", - "searchQueryTime" + "t" ], - "description": "time spent in query phase", - "name": "search.query_time", + "description": "The type of analysis that the job performs.", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -110732,8 +103992,12 @@ } }, { - "description": "time spent in query phase", - "name": "pri.search.query_time", + "aliases": [ + "ct", + "createTime" + ], + "description": "The time when the job was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", @@ -110745,51 +104009,57 @@ }, { "aliases": [ - "sqto", - "searchQueryTotal" + "v" ], - "description": "total query phase ops", - "name": "search.query_total", + "description": "The version of Elasticsearch when the job was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { - "description": "total query phase ops", - "name": "pri.search.query_total", + "aliases": [ + "si", + "sourceIndex" + ], + "description": "The name of the source index.", + "name": "source_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { "aliases": [ - "scc", - "searchScrollCurrent" + "di", + "destIndex" ], - "description": "open scroll contexts", - "name": "search.scroll_current", + "description": "The name of the destination index.", + "name": "dest_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { - "description": "open scroll contexts", - "name": "pri.search.scroll_current", + "aliases": [ + "d" + ], + "description": "A description of the job.", + "name": "description", "required": false, "type": { "kind": "instance_of", @@ -110801,11 +104071,11 @@ }, { "aliases": [ - "scti", - "searchScrollTime" + "mml", + "modelMemoryLimit" ], - "description": "time scroll contexts held open", - "name": "search.scroll_time", + "description": "The approximate maximum amount of memory resources that are permitted for the job.", + "name": "model_memory_limit", "required": false, "type": { "kind": "instance_of", @@ -110816,8 +104086,11 @@ } }, { - "description": "time scroll contexts held open", - "name": "pri.search.scroll_time", + "aliases": [ + "s" + ], + "description": "The current status of the job.", + "name": "state", "required": false, "type": { "kind": "instance_of", @@ -110829,11 +104102,11 @@ }, { "aliases": [ - "scto", - "searchScrollTotal" + "fr", + "failureReason" ], - "description": "completed scroll contexts", - "name": "search.scroll_total", + "description": "Messages about the reason why the job failed.", + "name": "failure_reason", "required": false, "type": { "kind": "instance_of", @@ -110844,8 +104117,11 @@ } }, { - "description": "completed scroll contexts", - "name": "pri.search.scroll_total", + "aliases": [ + "p" + ], + "description": "The progress report for the job by phase.", + "name": "progress", "required": false, "type": { "kind": "instance_of", @@ -110857,11 +104133,11 @@ }, { "aliases": [ - "sc", - "segmentsCount" + "ae", + "assignmentExplanation" ], - "description": "number of segments", - "name": "segments.count", + "description": "Messages related to the selection of a node.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -110872,52 +104148,60 @@ } }, { - "description": "number of segments", - "name": "pri.segments.count", + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the assigned node.", + "name": "node.id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "sm", - "segmentsMemory" + "nn", + "nodeName" ], - "description": "memory used by segments", - "name": "segments.memory", + "description": "The name of the assigned node.", + "name": "node.name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "description": "memory used by segments", - "name": "pri.segments.memory", + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral identifier of the assigned node.", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "siwm", - "segmentsIndexWriterMemory" + "na", + "nodeAddress" ], - "description": "memory used by index writer", - "name": "segments.index_writer_memory", + "description": "The network address of the assigned node.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -110926,10 +104210,20 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_data_frame_analytics/types.ts#L22-L102" + }, + { + "kind": "interface", + "name": { + "name": "DatafeedsRecord", + "namespace": "cat.ml_datafeeds" + }, + "properties": [ { - "description": "memory used by index writer", - "name": "pri.segments.index_writer_memory", + "description": "The datafeed identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", @@ -110941,23 +104235,25 @@ }, { "aliases": [ - "svmm", - "segmentsVersionMapMemory" + "s" ], - "description": "memory used by version map", - "name": "segments.version_map_memory", + "description": "The status of the datafeed.", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DatafeedState", + "namespace": "ml._types" } } }, { - "description": "memory used by version map", - "name": "pri.segments.version_map_memory", + "aliases": [ + "ae" + ], + "description": "For started datafeeds only, contains messages relating to the selection of a node.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -110969,11 +104265,11 @@ }, { "aliases": [ - "sfbm", - "fixedBitsetMemory" + "bc", + "bucketsCount" ], - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "segments.fixed_bitset_memory", + "description": "The number of buckets processed.", + "name": "buckets.count", "required": false, "type": { "kind": "instance_of", @@ -110984,8 +104280,12 @@ } }, { - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "pri.segments.fixed_bitset_memory", + "aliases": [ + "sc", + "searchCount" + ], + "description": "The number of searches run by the datafeed.", + "name": "search.count", "required": false, "type": { "kind": "instance_of", @@ -110997,11 +104297,11 @@ }, { "aliases": [ - "wc", - "warmerCurrent" + "st", + "searchTime" ], - "description": "current warmer ops", - "name": "warmer.current", + "description": "The total time the datafeed spent searching, in milliseconds.", + "name": "search.time", "required": false, "type": { "kind": "instance_of", @@ -111012,8 +104312,12 @@ } }, { - "description": "current warmer ops", - "name": "pri.warmer.current", + "aliases": [ + "sba", + "searchBucketAvg" + ], + "description": "The average search time per bucket, in milliseconds.", + "name": "search.bucket_avg", "required": false, "type": { "kind": "instance_of", @@ -111025,11 +104329,11 @@ }, { "aliases": [ - "wto", - "warmerTotal" + "seah", + "searchExpAvgHour" ], - "description": "total warmer ops", - "name": "warmer.total", + "description": "The exponential average search time per hour, in milliseconds.", + "name": "search.exp_avg_hour", "required": false, "type": { "kind": "instance_of", @@ -111040,8 +104344,12 @@ } }, { - "description": "total warmer ops", - "name": "pri.warmer.total", + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.id", "required": false, "type": { "kind": "instance_of", @@ -111053,11 +104361,11 @@ }, { "aliases": [ - "wtt", - "warmerTotalTime" + "nn", + "nodeName" ], - "description": "time spent in warmers", - "name": "warmer.total_time", + "description": "The name of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.name", "required": false, "type": { "kind": "instance_of", @@ -111068,8 +104376,12 @@ } }, { - "description": "time spent in warmers", - "name": "pri.warmer.total_time", + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", @@ -111081,11 +104393,11 @@ }, { "aliases": [ - "suc", - "suggestCurrent" + "na", + "nodeAddress" ], - "description": "number of current suggest ops", - "name": "suggest.current", + "description": "The network address of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -111094,54 +104406,50 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_datafeeds/types.ts#L22-L87" + }, + { + "kind": "interface", + "name": { + "name": "JobsRecord", + "namespace": "cat.ml_jobs" + }, + "properties": [ { - "description": "number of current suggest ops", - "name": "pri.suggest.current", + "description": "The anomaly detection job identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "suti", - "suggestTime" + "s" ], - "description": "time spend in suggest", - "name": "suggest.time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "time spend in suggest", - "name": "pri.suggest.time", + "description": "The status of the anomaly detection job.", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "JobState", + "namespace": "ml._types" } } }, { "aliases": [ - "suto", - "suggestTotal" + "ot" ], - "description": "number of suggest ops", - "name": "suggest.total", + "description": "For open jobs only, the amount of time the job has been opened.", + "name": "opened_time", "required": false, "type": { "kind": "instance_of", @@ -111152,8 +104460,11 @@ } }, { - "description": "number of suggest ops", - "name": "pri.suggest.total", + "aliases": [ + "ae" + ], + "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -111165,11 +104476,11 @@ }, { "aliases": [ - "tm", - "memoryTotal" + "dpr", + "dataProcessedRecords" ], - "description": "total used memory", - "name": "memory.total", + "description": "The number of input documents that have been processed by the anomaly detection job.\nThis value includes documents with missing fields, since they are nonetheless analyzed.\nIf you use datafeeds and have aggregations in your search query, the `processed_record_count` is the number of aggregation results processed, not the number of Elasticsearch documents.", + "name": "data.processed_records", "required": false, "type": { "kind": "instance_of", @@ -111180,8 +104491,12 @@ } }, { - "description": "total user memory", - "name": "pri.memory.total", + "aliases": [ + "dpf", + "dataProcessedFields" + ], + "description": "The total number of fields in all the documents that have been processed by the anomaly detection job.\nOnly fields that are specified in the detector configuration object contribute to this count.\nThe timestamp is not included in this count.", + "name": "data.processed_fields", "required": false, "type": { "kind": "instance_of", @@ -111193,26 +104508,27 @@ }, { "aliases": [ - "sth" + "dib", + "dataInputBytes" ], - "description": "indicates if the index is search throttled", - "name": "search.throttled", + "description": "The number of bytes of input data posted to the anomaly detection job.", + "name": "data.input_bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "bto", - "bulkTotalOperation" + "dir", + "dataInputRecords" ], - "description": "number of bulk shard ops", - "name": "bulk.total_operations", + "description": "The number of input documents posted to the anomaly detection job.", + "name": "data.input_records", "required": false, "type": { "kind": "instance_of", @@ -111223,8 +104539,12 @@ } }, { - "description": "number of bulk shard ops", - "name": "pri.bulk.total_operations", + "aliases": [ + "dif", + "dataInputFields" + ], + "description": "The total number of fields in input documents posted to the anomaly detection job.\nThis count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.", + "name": "data.input_fields", "required": false, "type": { "kind": "instance_of", @@ -111236,11 +104556,11 @@ }, { "aliases": [ - "btti", - "bulkTotalTime" + "did", + "dataInvalidDates" ], - "description": "time spend in shard bulk", - "name": "bulk.total_time", + "description": "The number of input documents with either a missing date field or a date that could not be parsed.", + "name": "data.invalid_dates", "required": false, "type": { "kind": "instance_of", @@ -111251,8 +104571,12 @@ } }, { - "description": "time spend in shard bulk", - "name": "pri.bulk.total_time", + "aliases": [ + "dmf", + "dataMissingFields" + ], + "description": "The number of input documents that are missing a field that the anomaly detection job is configured to analyze.\nInput documents with missing fields are still processed because it is possible that not all fields are missing.\nIf you are using datafeeds or posting data to the job in JSON format, a high `missing_field_count` is often not an indication of data issues.\nIt is not necessarily a cause for concern.", + "name": "data.missing_fields", "required": false, "type": { "kind": "instance_of", @@ -111264,11 +104588,11 @@ }, { "aliases": [ - "btsi", - "bulkTotalSizeInBytes" + "doot", + "dataOutOfOrderTimestamps" ], - "description": "total size in bytes of shard bulk", - "name": "bulk.total_size_in_bytes", + "description": "The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window.\nThis information is applicable only when you provide data to the anomaly detection job by using the post data API.\nThese out of order documents are discarded, since jobs require time series data to be in ascending chronological order.", + "name": "data.out_of_order_timestamps", "required": false, "type": { "kind": "instance_of", @@ -111279,8 +104603,12 @@ } }, { - "description": "total size in bytes of shard bulk", - "name": "pri.bulk.total_size_in_bytes", + "aliases": [ + "deb", + "dataEmptyBuckets" + ], + "description": "The number of buckets which did not contain any data.\nIf your data contains many empty buckets, consider increasing your `bucket_span` or using functions that are tolerant to gaps in data such as mean, `non_null_sum` or `non_zero_count`.", + "name": "data.empty_buckets", "required": false, "type": { "kind": "instance_of", @@ -111292,11 +104620,11 @@ }, { "aliases": [ - "bati", - "bulkAvgTime" + "dsb", + "dataSparseBuckets" ], - "description": "average time spend in shard bulk", - "name": "bulk.avg_time", + "description": "The number of buckets that contained few data points compared to the expected number of data points.\nIf your data contains many sparse buckets, consider using a longer `bucket_span`.", + "name": "data.sparse_buckets", "required": false, "type": { "kind": "instance_of", @@ -111307,8 +104635,12 @@ } }, { - "description": "average time spend in shard bulk", - "name": "pri.bulk.avg_time", + "aliases": [ + "db", + "dataBuckets" + ], + "description": "The total number of buckets processed.", + "name": "data.buckets", "required": false, "type": { "kind": "instance_of", @@ -111320,11 +104652,11 @@ }, { "aliases": [ - "basi", - "bulkAvgSizeInBytes" + "der", + "dataEarliestRecord" ], - "description": "average size in bytes of shard bulk", - "name": "bulk.avg_size_in_bytes", + "description": "The timestamp of the earliest chronologically input document.", + "name": "data.earliest_record", "required": false, "type": { "kind": "instance_of", @@ -111335,8 +104667,12 @@ } }, { - "description": "average size in bytes of shard bulk", - "name": "pri.bulk.avg_size_in_bytes", + "aliases": [ + "dlr", + "dataLatestRecord" + ], + "description": "The timestamp of the latest chronologically input document.", + "name": "data.latest_record", "required": false, "type": { "kind": "instance_of", @@ -111345,35 +104681,30 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/indices/types.ts#L20-L808" - }, - { - "kind": "interface", - "name": { - "name": "DataFrameAnalyticsRecord", - "namespace": "cat.ml_data_frame_analytics" - }, - "properties": [ + }, { - "description": "The identifier for the job.", - "name": "id", + "aliases": [ + "dl", + "dataLast" + ], + "description": "The timestamp at which data was last analyzed, according to server time.", + "name": "data.last", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "t" + "dleb", + "dataLastEmptyBucket" ], - "description": "The type of analysis that the job performs.", - "name": "type", + "description": "The timestamp of the last bucket that did not contain any data.", + "name": "data.last_empty_bucket", "required": false, "type": { "kind": "instance_of", @@ -111385,11 +104716,11 @@ }, { "aliases": [ - "ct", - "createTime" + "dlsb", + "dataLastSparseBucket" ], - "description": "The time when the job was created.", - "name": "create_time", + "description": "The timestamp of the last bucket that was considered sparse.", + "name": "data.last_sparse_bucket", "required": false, "type": { "kind": "instance_of", @@ -111401,57 +104732,59 @@ }, { "aliases": [ - "v" + "mb", + "modelBytes" ], - "description": "The version of Elasticsearch when the job was created.", - "name": "version", + "description": "The number of bytes of memory used by the models.\nThis is the maximum value since the last time the model was persisted.\nIf the job is closed, this value indicates the latest size.", + "name": "model.bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "ByteSize", "namespace": "_types" } } }, { "aliases": [ - "si", - "sourceIndex" + "mms", + "modelMemoryStatus" ], - "description": "The name of the source index.", - "name": "source_index", + "description": "The status of the mathematical models.", + "name": "model.memory_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "MemoryStatus", + "namespace": "ml._types" } } }, { "aliases": [ - "di", - "destIndex" + "mbe", + "modelBytesExceeded" ], - "description": "The name of the destination index.", - "name": "dest_index", + "description": "The number of bytes over the high limit for memory usage at the last allocation failure.", + "name": "model.bytes_exceeded", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "ByteSize", "namespace": "_types" } } }, { "aliases": [ - "d" + "mml", + "modelMemoryLimit" ], - "description": "A description of the job.", - "name": "description", + "description": "The upper limit for model memory usage, checked on increasing values.", + "name": "model.memory_limit", "required": false, "type": { "kind": "instance_of", @@ -111463,11 +104796,11 @@ }, { "aliases": [ - "mml", - "modelMemoryLimit" + "mbf", + "modelByFields" ], - "description": "The approximate maximum amount of memory resources that are permitted for the job.", - "name": "model_memory_limit", + "description": "The number of `by` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.by_fields", "required": false, "type": { "kind": "instance_of", @@ -111479,10 +104812,11 @@ }, { "aliases": [ - "s" + "mof", + "modelOverFields" ], - "description": "The current status of the job.", - "name": "state", + "description": "The number of `over` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.over_fields", "required": false, "type": { "kind": "instance_of", @@ -111494,11 +104828,11 @@ }, { "aliases": [ - "fr", - "failureReason" + "mpf", + "modelPartitionFields" ], - "description": "Messages about the reason why the job failed.", - "name": "failure_reason", + "description": "The number of `partition` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.partition_fields", "required": false, "type": { "kind": "instance_of", @@ -111510,10 +104844,11 @@ }, { "aliases": [ - "p" + "mbaf", + "modelBucketAllocationFailures" ], - "description": "The progress report for the job by phase.", - "name": "progress", + "description": "The number of buckets for which new entities in incoming data were not processed due to insufficient model memory.\nThis situation is also signified by a `hard_limit: memory_status` property value.", + "name": "model.bucket_allocation_failures", "required": false, "type": { "kind": "instance_of", @@ -111525,75 +104860,74 @@ }, { "aliases": [ - "ae", - "assignmentExplanation" + "mcs", + "modelCategorizationStatus" ], - "description": "Messages related to the selection of a node.", - "name": "assignment_explanation", + "description": "The status of categorization for the job.", + "name": "model.categorization_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CategorizationStatus", + "namespace": "ml._types" } } }, { "aliases": [ - "ni", - "nodeId" + "mcdc", + "modelCategorizedDocCount" ], - "description": "The unique identifier of the assigned node.", - "name": "node.id", + "description": "The number of documents that have had a field categorized.", + "name": "model.categorized_doc_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "nn", - "nodeName" + "mtcc", + "modelTotalCategoryCount" ], - "description": "The name of the assigned node.", - "name": "node.name", + "description": "The number of categories created by categorization.", + "name": "model.total_category_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ne", - "nodeEphemeralId" + "modelFrequentCategoryCount" ], - "description": "The ephemeral identifier of the assigned node.", - "name": "node.ephemeral_id", + "description": "The number of categories that match more than 1% of categorized documents.", + "name": "model.frequent_category_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "na", - "nodeAddress" + "mrcc", + "modelRareCategoryCount" ], - "description": "The network address of the assigned node.", - "name": "node.address", + "description": "The number of categories that match just one categorized document.", + "name": "model.rare_category_count", "required": false, "type": { "kind": "instance_of", @@ -111602,20 +104936,14 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_data_frame_analytics/types.ts#L22-L102" - }, - { - "kind": "interface", - "name": { - "name": "DatafeedsRecord", - "namespace": "cat.ml_datafeeds" - }, - "properties": [ + }, { - "description": "The datafeed identifier.", - "name": "id", + "aliases": [ + "mdcc", + "modelDeadCategoryCount" + ], + "description": "The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category.\nDead categories are a side effect of the way categorization has no prior training.", + "name": "model.dead_category_count", "required": false, "type": { "kind": "instance_of", @@ -111627,25 +104955,27 @@ }, { "aliases": [ - "s" + "mfcc", + "modelFailedCategoryCount" ], - "description": "The status of the datafeed.", - "name": "state", + "description": "The number of times that categorization wanted to create a new category but couldn’t because the job had hit its `model_memory_limit`.\nThis count does not track which specific categories failed to be created.\nTherefore you cannot use this value to determine the number of unique categories that were missed.", + "name": "model.failed_category_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedState", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ae" + "mlt", + "modelLogTime" ], - "description": "For started datafeeds only, contains messages relating to the selection of a node.", - "name": "assignment_explanation", + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.log_time", "required": false, "type": { "kind": "instance_of", @@ -111657,11 +104987,11 @@ }, { "aliases": [ - "bc", - "bucketsCount" + "mt", + "modelTimestamp" ], - "description": "The number of buckets processed.", - "name": "buckets.count", + "description": "The timestamp of the last record when the model stats were gathered.", + "name": "model.timestamp", "required": false, "type": { "kind": "instance_of", @@ -111673,11 +105003,11 @@ }, { "aliases": [ - "sc", - "searchCount" + "ft", + "forecastsTotal" ], - "description": "The number of searches run by the datafeed.", - "name": "search.count", + "description": "The number of individual forecasts currently available for the job.\nA value of one or more indicates that forecasts exist.", + "name": "forecasts.total", "required": false, "type": { "kind": "instance_of", @@ -111689,11 +105019,11 @@ }, { "aliases": [ - "st", - "searchTime" + "fmmin", + "forecastsMemoryMin" ], - "description": "The total time the datafeed spent searching, in milliseconds.", - "name": "search.time", + "description": "The minimum memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.min", "required": false, "type": { "kind": "instance_of", @@ -111705,11 +105035,11 @@ }, { "aliases": [ - "sba", - "searchBucketAvg" + "fmmax", + "forecastsMemoryMax" ], - "description": "The average search time per bucket, in milliseconds.", - "name": "search.bucket_avg", + "description": "The maximum memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.max", "required": false, "type": { "kind": "instance_of", @@ -111721,11 +105051,11 @@ }, { "aliases": [ - "seah", - "searchExpAvgHour" + "fmavg", + "forecastsMemoryAvg" ], - "description": "The exponential average search time per hour, in milliseconds.", - "name": "search.exp_avg_hour", + "description": "The average memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.avg", "required": false, "type": { "kind": "instance_of", @@ -111737,11 +105067,11 @@ }, { "aliases": [ - "ni", - "nodeId" + "fmt", + "forecastsMemoryTotal" ], - "description": "The unique identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.id", + "description": "The total memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.total", "required": false, "type": { "kind": "instance_of", @@ -111753,11 +105083,11 @@ }, { "aliases": [ - "nn", - "nodeName" + "frmin", + "forecastsRecordsMin" ], - "description": "The name of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.name", + "description": "The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.min", "required": false, "type": { "kind": "instance_of", @@ -111769,11 +105099,11 @@ }, { "aliases": [ - "ne", - "nodeEphemeralId" + "frmax", + "forecastsRecordsMax" ], - "description": "The ephemeral identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.ephemeral_id", + "description": "The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.max", "required": false, "type": { "kind": "instance_of", @@ -111785,11 +105115,11 @@ }, { "aliases": [ - "na", - "nodeAddress" + "fravg", + "forecastsRecordsAvg" ], - "description": "The network address of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.address", + "description": "The average number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.avg", "required": false, "type": { "kind": "instance_of", @@ -111798,50 +105128,46 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_datafeeds/types.ts#L22-L87" - }, - { - "kind": "interface", - "name": { - "name": "JobsRecord", - "namespace": "cat.ml_jobs" - }, - "properties": [ + }, { - "description": "The anomaly detection job identifier.", - "name": "id", + "aliases": [ + "frt", + "forecastsRecordsTotal" + ], + "description": "The total number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "s" + "ftmin", + "forecastsTimeMin" ], - "description": "The status of the anomaly detection job.", - "name": "state", + "description": "The minimum runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.min", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JobState", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ot" + "ftmax", + "forecastsTimeMax" ], - "description": "For open jobs only, the amount of time the job has been opened.", - "name": "opened_time", + "description": "The maximum runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.max", "required": false, "type": { "kind": "instance_of", @@ -111853,10 +105179,11 @@ }, { "aliases": [ - "ae" + "ftavg", + "forecastsTimeAvg" ], - "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.", - "name": "assignment_explanation", + "description": "The average runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.avg", "required": false, "type": { "kind": "instance_of", @@ -111868,11 +105195,11 @@ }, { "aliases": [ - "dpr", - "dataProcessedRecords" + "ftt", + "forecastsTimeTotal" ], - "description": "The number of input documents that have been processed by the anomaly detection job.\nThis value includes documents with missing fields, since they are nonetheless analyzed.\nIf you use datafeeds and have aggregations in your search query, the `processed_record_count` is the number of aggregation results processed, not the number of Elasticsearch documents.", - "name": "data.processed_records", + "description": "The total runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.total", "required": false, "type": { "kind": "instance_of", @@ -111884,59 +105211,59 @@ }, { "aliases": [ - "dpf", - "dataProcessedFields" + "ni", + "nodeId" ], - "description": "The total number of fields in all the documents that have been processed by the anomaly detection job.\nOnly fields that are specified in the detector configuration object contribute to this count.\nThe timestamp is not included in this count.", - "name": "data.processed_fields", + "description": "The uniqe identifier of the assigned node.", + "name": "node.id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "dib", - "dataInputBytes" + "nn", + "nodeName" ], - "description": "The number of bytes of input data posted to the anomaly detection job.", - "name": "data.input_bytes", + "description": "The name of the assigned node.", + "name": "node.name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "dir", - "dataInputRecords" + "ne", + "nodeEphemeralId" ], - "description": "The number of input documents posted to the anomaly detection job.", - "name": "data.input_records", + "description": "The ephemeral identifier of the assigned node.", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "dif", - "dataInputFields" + "na", + "nodeAddress" ], - "description": "The total number of fields in input documents posted to the anomaly detection job.\nThis count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.", - "name": "data.input_fields", + "description": "The network address of the assigned node.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -111948,11 +105275,11 @@ }, { "aliases": [ - "did", - "dataInvalidDates" + "bc", + "bucketsCount" ], - "description": "The number of input documents with either a missing date field or a date that could not be parsed.", - "name": "data.invalid_dates", + "description": "The number of bucket results produced by the job.", + "name": "buckets.count", "required": false, "type": { "kind": "instance_of", @@ -111964,11 +105291,11 @@ }, { "aliases": [ - "dmf", - "dataMissingFields" + "btt", + "bucketsTimeTotal" ], - "description": "The number of input documents that are missing a field that the anomaly detection job is configured to analyze.\nInput documents with missing fields are still processed because it is possible that not all fields are missing.\nIf you are using datafeeds or posting data to the job in JSON format, a high `missing_field_count` is often not an indication of data issues.\nIt is not necessarily a cause for concern.", - "name": "data.missing_fields", + "description": "The sum of all bucket processing times, in milliseconds.", + "name": "buckets.time.total", "required": false, "type": { "kind": "instance_of", @@ -111980,11 +105307,11 @@ }, { "aliases": [ - "doot", - "dataOutOfOrderTimestamps" + "btmin", + "bucketsTimeMin" ], - "description": "The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window.\nThis information is applicable only when you provide data to the anomaly detection job by using the post data API.\nThese out of order documents are discarded, since jobs require time series data to be in ascending chronological order.", - "name": "data.out_of_order_timestamps", + "description": "The minimum of all bucket processing times, in milliseconds.", + "name": "buckets.time.min", "required": false, "type": { "kind": "instance_of", @@ -111996,11 +105323,11 @@ }, { "aliases": [ - "deb", - "dataEmptyBuckets" + "btmax", + "bucketsTimeMax" ], - "description": "The number of buckets which did not contain any data.\nIf your data contains many empty buckets, consider increasing your `bucket_span` or using functions that are tolerant to gaps in data such as mean, `non_null_sum` or `non_zero_count`.", - "name": "data.empty_buckets", + "description": "The maximum of all bucket processing times, in milliseconds.", + "name": "buckets.time.max", "required": false, "type": { "kind": "instance_of", @@ -112012,11 +105339,11 @@ }, { "aliases": [ - "dsb", - "dataSparseBuckets" + "btea", + "bucketsTimeExpAvg" ], - "description": "The number of buckets that contained few data points compared to the expected number of data points.\nIf your data contains many sparse buckets, consider using a longer `bucket_span`.", - "name": "data.sparse_buckets", + "description": "The exponential moving average of all bucket processing times, in milliseconds.", + "name": "buckets.time.exp_avg", "required": false, "type": { "kind": "instance_of", @@ -112028,11 +105355,11 @@ }, { "aliases": [ - "db", - "dataBuckets" + "bteah", + "bucketsTimeExpAvgHour" ], - "description": "The total number of buckets processed.", - "name": "data.buckets", + "description": "The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.", + "name": "buckets.time.exp_avg_hour", "required": false, "type": { "kind": "instance_of", @@ -112041,30 +105368,36 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_jobs/types.ts#L24-L347" + }, + { + "kind": "interface", + "name": { + "name": "TrainedModelsRecord", + "namespace": "cat.ml_trained_models" + }, + "properties": [ { - "aliases": [ - "der", - "dataEarliestRecord" - ], - "description": "The timestamp of the earliest chronologically input document.", - "name": "data.earliest_record", + "description": "The model identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "dlr", - "dataLatestRecord" + "c", + "createdBy" ], - "description": "The timestamp of the latest chronologically input document.", - "name": "data.latest_record", + "description": "Information about the creator of the model.", + "name": "created_by", "required": false, "type": { "kind": "instance_of", @@ -112076,27 +105409,27 @@ }, { "aliases": [ - "dl", - "dataLast" + "hs", + "modelHeapSize" ], - "description": "The timestamp at which data was last analyzed, according to server time.", - "name": "data.last", + "description": "The estimated heap size to keep the model in memory.", + "name": "heap_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "dleb", - "dataLastEmptyBucket" + "o", + "modelOperations" ], - "description": "The timestamp of the last bucket that did not contain any data.", - "name": "data.last_empty_bucket", + "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.", + "name": "operations", "required": false, "type": { "kind": "instance_of", @@ -112108,11 +105441,10 @@ }, { "aliases": [ - "dlsb", - "dataLastSparseBucket" + "l" ], - "description": "The timestamp of the last bucket that was considered sparse.", - "name": "data.last_sparse_bucket", + "description": "The license level of the model.", + "name": "license", "required": false, "type": { "kind": "instance_of", @@ -112124,59 +105456,56 @@ }, { "aliases": [ - "mb", - "modelBytes" + "ct" ], - "description": "The number of bytes of memory used by the models.\nThis is the maximum value since the last time the model was persisted.\nIf the job is closed, this value indicates the latest size.", - "name": "model.bytes", + "description": "The time the model was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "DateTime", "namespace": "_types" } } }, { "aliases": [ - "mms", - "modelMemoryStatus" + "v" ], - "description": "The status of the mathematical models.", - "name": "model.memory_status", + "description": "The version of Elasticsearch when the model was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MemoryStatus", - "namespace": "ml._types" + "name": "VersionString", + "namespace": "_types" } } }, { "aliases": [ - "mbe", - "modelBytesExceeded" + "d" ], - "description": "The number of bytes over the high limit for memory usage at the last allocation failure.", - "name": "model.bytes_exceeded", + "description": "A description of the model.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "mml", - "modelMemoryLimit" + "ip", + "ingestPipelines" ], - "description": "The upper limit for model memory usage, checked on increasing values.", - "name": "model.memory_limit", + "description": "The number of pipelines that are referencing the model.", + "name": "ingest.pipelines", "required": false, "type": { "kind": "instance_of", @@ -112188,11 +105517,11 @@ }, { "aliases": [ - "mbf", - "modelByFields" + "ic", + "ingestCount" ], - "description": "The number of `by` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.by_fields", + "description": "The total number of documents that are processed by the model.", + "name": "ingest.count", "required": false, "type": { "kind": "instance_of", @@ -112204,11 +105533,11 @@ }, { "aliases": [ - "mof", - "modelOverFields" + "it", + "ingestTime" ], - "description": "The number of `over` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.over_fields", + "description": "The total time spent processing documents with thie model.", + "name": "ingest.time", "required": false, "type": { "kind": "instance_of", @@ -112220,11 +105549,11 @@ }, { "aliases": [ - "mpf", - "modelPartitionFields" + "icurr", + "ingestCurrent" ], - "description": "The number of `partition` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.partition_fields", + "description": "The total number of documents that are currently being handled by the model.", + "name": "ingest.current", "required": false, "type": { "kind": "instance_of", @@ -112236,11 +105565,11 @@ }, { "aliases": [ - "mbaf", - "modelBucketAllocationFailures" + "if", + "ingestFailed" ], - "description": "The number of buckets for which new entities in incoming data were not processed due to insufficient model memory.\nThis situation is also signified by a `hard_limit: memory_status` property value.", - "name": "model.bucket_allocation_failures", + "description": "The total number of failed ingest attempts with the model.", + "name": "ingest.failed", "required": false, "type": { "kind": "instance_of", @@ -112252,27 +105581,27 @@ }, { "aliases": [ - "mcs", - "modelCategorizationStatus" + "dfid", + "dataFrameAnalytics" ], - "description": "The status of categorization for the job.", - "name": "model.categorization_status", + "description": "The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available.", + "name": "data_frame.id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CategorizationStatus", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "mcdc", - "modelCategorizedDocCount" + "dft", + "dataFrameAnalyticsTime" ], - "description": "The number of documents that have had a field categorized.", - "name": "model.categorized_doc_count", + "description": "The time the data frame analytics job was created.", + "name": "data_frame.create_time", "required": false, "type": { "kind": "instance_of", @@ -112284,11 +105613,11 @@ }, { "aliases": [ - "mtcc", - "modelTotalCategoryCount" + "dfsi", + "dataFrameAnalyticsSrcIndex" ], - "description": "The number of categories created by categorization.", - "name": "model.total_category_count", + "description": "The source index used to train in the data frame analysis.", + "name": "data_frame.source_index", "required": false, "type": { "kind": "instance_of", @@ -112300,10 +105629,11 @@ }, { "aliases": [ - "modelFrequentCategoryCount" + "dfa", + "dataFrameAnalyticsAnalysis" ], - "description": "The number of categories that match more than 1% of categorized documents.", - "name": "model.frequent_category_count", + "description": "The analysis used by the data frame to build the model.", + "name": "data_frame.analysis", "required": false, "type": { "kind": "instance_of", @@ -112314,12 +105644,13 @@ } }, { - "aliases": [ - "mrcc", - "modelRareCategoryCount" - ], - "description": "The number of categories that match just one categorized document.", - "name": "model.rare_category_count", + "availability": { + "serverless": {}, + "stack": { + "since": "8.0.0" + } + }, + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -112328,30 +105659,35 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_trained_models/types.ts#L23-L115" + }, + { + "kind": "interface", + "name": { + "name": "TransformsRecord", + "namespace": "cat.transforms" + }, + "properties": [ { - "aliases": [ - "mdcc", - "modelDeadCategoryCount" - ], - "description": "The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category.\nDead categories are a side effect of the way categorization has no prior training.", - "name": "model.dead_category_count", + "description": "The transform identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "mfcc", - "modelFailedCategoryCount" + "s" ], - "description": "The number of times that categorization wanted to create a new category but couldn’t because the job had hit its `model_memory_limit`.\nThis count does not track which specific categories failed to be created.\nTherefore you cannot use this value to determine the number of unique categories that were missed.", - "name": "model.failed_category_count", + "description": "The status of the transform.\nReturned values include:\n`aborting`: The transform is aborting.\n`failed: The transform failed. For more information about the failure, check the `reason` field.\n`indexing`: The transform is actively processing data and creating new documents.\n`started`: The transform is running but not actively indexing data.\n`stopped`: The transform is stopped.\n`stopping`: The transform is stopping.", + "name": "state", "required": false, "type": { "kind": "instance_of", @@ -112363,11 +105699,10 @@ }, { "aliases": [ - "mlt", - "modelLogTime" + "c" ], - "description": "The timestamp when the model stats were gathered, according to server time.", - "name": "model.log_time", + "description": "The sequence number for the checkpoint.", + "name": "checkpoint", "required": false, "type": { "kind": "instance_of", @@ -112379,11 +105714,11 @@ }, { "aliases": [ - "mt", - "modelTimestamp" + "docp", + "documentsProcessed" ], - "description": "The timestamp of the last record when the model stats were gathered.", - "name": "model.timestamp", + "description": "The number of documents that have been processed from the source index of the transform.", + "name": "documents_processed", "required": false, "type": { "kind": "instance_of", @@ -112395,43 +105730,94 @@ }, { "aliases": [ - "ft", - "forecastsTotal" + "cp", + "checkpointProgress" + ], + "description": "The progress of the next checkpoint that is currently in progress.", + "name": "checkpoint_progress", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "lst", + "lastSearchTime" ], - "description": "The number of individual forecasts currently available for the job.\nA value of one or more indicates that forecasts exist.", - "name": "forecasts.total", + "description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.", + "name": "last_search_time", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "fmmin", - "forecastsMemoryMin" + "cldt" ], - "description": "The minimum memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.min", + "description": "The timestamp when changes were last detected in the source indices.", + "name": "changes_last_detection_time", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "fmmax", - "forecastsMemoryMax" + "ct", + "createTime" ], - "description": "The maximum memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.max", + "description": "The time the transform was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", @@ -112443,27 +105829,26 @@ }, { "aliases": [ - "fmavg", - "forecastsMemoryAvg" + "v" ], - "description": "The average memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.avg", + "description": "The version of Elasticsearch that existed on the node when the transform was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { "aliases": [ - "fmt", - "forecastsMemoryTotal" + "si", + "sourceIndex" ], - "description": "The total memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.total", + "description": "The source indices for the transform.", + "name": "source_index", "required": false, "type": { "kind": "instance_of", @@ -112475,11 +105860,11 @@ }, { "aliases": [ - "frmin", - "forecastsRecordsMin" + "di", + "destIndex" ], - "description": "The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.min", + "description": "The destination index for the transform.", + "name": "dest_index", "required": false, "type": { "kind": "instance_of", @@ -112491,11 +105876,10 @@ }, { "aliases": [ - "frmax", - "forecastsRecordsMax" + "p" ], - "description": "The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.max", + "description": "The unique identifier for the ingest pipeline.", + "name": "pipeline", "required": false, "type": { "kind": "instance_of", @@ -112507,11 +105891,10 @@ }, { "aliases": [ - "fravg", - "forecastsRecordsAvg" + "d" ], - "description": "The average number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.avg", + "description": "The description of the transform.", + "name": "description", "required": false, "type": { "kind": "instance_of", @@ -112523,11 +105906,10 @@ }, { "aliases": [ - "frt", - "forecastsRecordsTotal" + "tt" ], - "description": "The total number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.total", + "description": "The type of transform: `batch` or `continuous`.", + "name": "transform_type", "required": false, "type": { "kind": "instance_of", @@ -112539,11 +105921,10 @@ }, { "aliases": [ - "ftmin", - "forecastsTimeMin" + "f" ], - "description": "The minimum runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.min", + "description": "The interval between checks for changes in the source indices when the transform is running continuously.", + "name": "frequency", "required": false, "type": { "kind": "instance_of", @@ -112555,11 +105936,10 @@ }, { "aliases": [ - "ftmax", - "forecastsTimeMax" + "mpsz" ], - "description": "The maximum runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.max", + "description": "The initial page size that is used for the composite aggregation for each checkpoint.", + "name": "max_page_search_size", "required": false, "type": { "kind": "instance_of", @@ -112571,11 +105951,10 @@ }, { "aliases": [ - "ftavg", - "forecastsTimeAvg" + "dps" ], - "description": "The average runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.avg", + "description": "The number of input documents per second.", + "name": "docs_per_second", "required": false, "type": { "kind": "instance_of", @@ -112587,11 +105966,10 @@ }, { "aliases": [ - "ftt", - "forecastsTimeTotal" + "r" ], - "description": "The total runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.total", + "description": "If a transform has a `failed` state, these details describe the reason for failure.", + "name": "reason", "required": false, "type": { "kind": "instance_of", @@ -112603,27 +105981,25 @@ }, { "aliases": [ - "ni", - "nodeId" + "st" ], - "description": "The uniqe identifier of the assigned node.", - "name": "node.id", + "description": "The total number of search operations on the source index for the transform.", + "name": "search_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "nn", - "nodeName" + "sf" ], - "description": "The name of the assigned node.", - "name": "node.name", + "description": "The total number of search failures.", + "name": "search_failure", "required": false, "type": { "kind": "instance_of", @@ -112635,27 +106011,25 @@ }, { "aliases": [ - "ne", - "nodeEphemeralId" + "stime" ], - "description": "The ephemeral identifier of the assigned node.", - "name": "node.ephemeral_id", + "description": "The total amount of search time, in milliseconds.", + "name": "search_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "na", - "nodeAddress" + "it" ], - "description": "The network address of the assigned node.", - "name": "node.address", + "description": "The total number of index operations done by the transform.", + "name": "index_total", "required": false, "type": { "kind": "instance_of", @@ -112667,11 +106041,10 @@ }, { "aliases": [ - "bc", - "bucketsCount" + "if" ], - "description": "The number of bucket results produced by the job.", - "name": "buckets.count", + "description": "The total number of indexing failures.", + "name": "index_failure", "required": false, "type": { "kind": "instance_of", @@ -112683,11 +106056,10 @@ }, { "aliases": [ - "btt", - "bucketsTimeTotal" + "itime" ], - "description": "The sum of all bucket processing times, in milliseconds.", - "name": "buckets.time.total", + "description": "The total time spent indexing documents, in milliseconds.", + "name": "index_time", "required": false, "type": { "kind": "instance_of", @@ -112699,11 +106071,10 @@ }, { "aliases": [ - "btmin", - "bucketsTimeMin" + "doci" ], - "description": "The minimum of all bucket processing times, in milliseconds.", - "name": "buckets.time.min", + "description": "The number of documents that have been indexed into the destination index for the transform.", + "name": "documents_indexed", "required": false, "type": { "kind": "instance_of", @@ -112715,11 +106086,10 @@ }, { "aliases": [ - "btmax", - "bucketsTimeMax" + "dtime" ], - "description": "The maximum of all bucket processing times, in milliseconds.", - "name": "buckets.time.max", + "description": "The total time spent deleting documents, in milliseconds.", + "name": "delete_time", "required": false, "type": { "kind": "instance_of", @@ -112731,11 +106101,10 @@ }, { "aliases": [ - "btea", - "bucketsTimeExpAvg" + "docd" ], - "description": "The exponential moving average of all bucket processing times, in milliseconds.", - "name": "buckets.time.exp_avg", + "description": "The number of documents deleted from the destination index due to the retention policy for the transform.", + "name": "documents_deleted", "required": false, "type": { "kind": "instance_of", @@ -112747,11 +106116,10 @@ }, { "aliases": [ - "bteah", - "bucketsTimeExpAvgHour" + "tc" ], - "description": "The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.", - "name": "buckets.time.exp_avg_hour", + "description": "The number of times the transform has been triggered by the scheduler.\nFor example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property.", + "name": "trigger_count", "required": false, "type": { "kind": "instance_of", @@ -112760,36 +106128,13 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_jobs/types.ts#L24-L347" - }, - { - "kind": "interface", - "name": { - "name": "TrainedModelsRecord", - "namespace": "cat.ml_trained_models" - }, - "properties": [ - { - "description": "The model identifier.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } }, { "aliases": [ - "c", - "createdBy" + "pp" ], - "description": "Information about the creator of the model.", - "name": "created_by", + "description": "The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually.", + "name": "pages_processed", "required": false, "type": { "kind": "instance_of", @@ -112801,27 +106146,26 @@ }, { "aliases": [ - "hs", - "modelHeapSize" + "pt" ], - "description": "The estimated heap size to keep the model in memory.", - "name": "heap_size", + "description": "The total time spent processing results, in milliseconds.", + "name": "processing_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "o", - "modelOperations" + "cdtea", + "checkpointTimeExpAvg" ], - "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.", - "name": "operations", + "description": "The exponential moving average of the duration of the checkpoint, in milliseconds.", + "name": "checkpoint_duration_time_exp_avg", "required": false, "type": { "kind": "instance_of", @@ -112833,10 +106177,10 @@ }, { "aliases": [ - "l" + "idea" ], - "description": "The license level of the model.", - "name": "license", + "description": "The exponential moving average of the number of new documents that have been indexed.", + "name": "indexed_documents_exp_avg", "required": false, "type": { "kind": "instance_of", @@ -112848,269 +106192,268 @@ }, { "aliases": [ - "ct" + "pdea" ], - "description": "The time the model was created.", - "name": "create_time", + "description": "The exponential moving average of the number of documents that have been processed.", + "name": "processed_documents_exp_avg", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/transforms/types.ts#L22-L197" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplate", + "namespace": "cluster._types" + }, + "properties": [ { - "aliases": [ - "v" - ], - "description": "The version of Elasticsearch when the model was created.", - "name": "version", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "Name", "namespace": "_types" } } }, { - "aliases": [ - "d" - ], - "description": "A description of the model.", - "name": "description", - "required": false, + "name": "component_template", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ComponentTemplateNode", + "namespace": "cluster._types" } } - }, + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L27-L30" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplateNode", + "namespace": "cluster._types" + }, + "properties": [ { - "aliases": [ - "ip", - "ingestPipelines" - ], - "description": "The number of pipelines that are referencing the model.", - "name": "ingest.pipelines", - "required": false, + "name": "template", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ComponentTemplateSummary", + "namespace": "cluster._types" } } }, { - "aliases": [ - "ic", - "ingestCount" - ], - "description": "The total number of documents that are processed by the model.", - "name": "ingest.count", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "it", - "ingestTime" - ], - "description": "The total time spent processing documents with thie model.", - "name": "ingest.time", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Metadata", + "namespace": "_types" } } }, { - "aliases": [ - "icurr", - "ingestCurrent" - ], - "description": "The total number of documents that are currently being handled by the model.", - "name": "ingest.current", + "name": "deprecated", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L32-L41" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplateSummary", + "namespace": "cluster._types" + }, + "properties": [ { - "aliases": [ - "if", - "ingestFailed" - ], - "description": "The total number of failed ingest attempts with the model.", - "name": "ingest.failed", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Metadata", + "namespace": "_types" } } }, { - "aliases": [ - "dfid", - "dataFrameAnalytics" - ], - "description": "The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available.", - "name": "data_frame.id", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "dft", - "dataFrameAnalyticsTime" - ], - "description": "The time the data frame analytics job was created.", - "name": "data_frame.create_time", + "name": "settings", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } } } }, { - "aliases": [ - "dfsi", - "dataFrameAnalyticsSrcIndex" - ], - "description": "The source index used to train in the data frame analysis.", - "name": "data_frame.source_index", + "name": "mappings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "aliases": [ - "dfa", - "dataFrameAnalyticsAnalysis" - ], - "description": "The analysis used by the data frame to build the model.", - "name": "data_frame.analysis", + "name": "aliases", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AliasDefinition", + "namespace": "indices._types" + } } } }, { "availability": { - "serverless": {}, + "serverless": { + "stability": "stable" + }, "stack": { - "since": "8.0.0" + "since": "8.11.0", + "stability": "stable" } }, - "name": "type", + "name": "lifecycle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DataStreamLifecycleWithRollover", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L43-L55" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" } + ], + "meta": { + "description": "Additional settings not covered in this type.", + "fieldname": "other_settings" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" } } ], - "specLocation": "cat/ml_trained_models/types.ts#L23-L115" - }, - { + "docId": "index-modules-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html#index-modules-settings", "kind": "interface", "name": { - "name": "TransformsRecord", - "namespace": "cat.transforms" + "name": "IndexSettings", + "namespace": "indices._types" }, "properties": [ { - "description": "The transform identifier.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "aliases": [ - "s" - ], - "description": "The status of the transform.\nReturned values include:\n`aborting`: The transform is aborting.\n`failed: The transform failed. For more information about the failure, check the `reason` field.\n`indexing`: The transform is actively processing data and creating new documents.\n`started`: The transform is running but not actively indexing data.\n`stopped`: The transform is stopped.\n`stopping`: The transform is stopping.", - "name": "state", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "aliases": [ - "c" - ], - "description": "The sequence number for the checkpoint.", - "name": "checkpoint", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexSettings", + "namespace": "indices._types" } } }, { - "aliases": [ - "docp", - "documentsProcessed" - ], - "description": "The number of documents that have been processed from the source index of the transform.", - "name": "documents_processed", + "name": "mode", "required": false, "type": { "kind": "instance_of", @@ -113121,12 +106464,7 @@ } }, { - "aliases": [ - "cp", - "checkpointProgress" - ], - "description": "The progress of the next checkpoint that is currently in progress.", - "name": "checkpoint_progress", + "name": "routing_path", "required": false, "type": { "items": [ @@ -113138,10 +106476,13 @@ } }, { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], @@ -113149,99 +106490,54 @@ } }, { - "aliases": [ - "lst", - "lastSearchTime" - ], - "description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.", - "name": "last_search_time", + "name": "soft_deletes", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SoftDeletes", + "namespace": "indices._types" + } } }, { - "aliases": [ - "cldt" - ], - "description": "The timestamp when changes were last detected in the source indices.", - "name": "changes_last_detection_time", + "name": "sort", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "IndexSegmentSort", + "namespace": "indices._types" + } } }, { - "aliases": [ - "ct", - "createTime" - ], - "description": "The time the transform was created.", - "name": "create_time", + "name": "number_of_routing_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "v" - ], - "description": "The version of Elasticsearch that existed on the node when the transform was created.", - "name": "version", + "name": "check_on_startup", "required": false, + "serverDefault": "false", "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "IndexCheckOnStartup", + "namespace": "indices._types" } } }, { - "aliases": [ - "si", - "sourceIndex" - ], - "description": "The source indices for the transform.", - "name": "source_index", + "name": "codec", "required": false, + "serverDefault": "LZ4", "type": { "kind": "instance_of", "type": { @@ -113251,744 +106547,751 @@ } }, { - "aliases": [ - "di", - "destIndex" - ], - "description": "The destination index for the transform.", - "name": "dest_index", + "name": "routing_partition_size", "required": false, + "serverDefault": "1", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "p" - ], - "description": "The unique identifier for the ingest pipeline.", - "name": "pipeline", + "name": "load_fixed_bitset_filters_eagerly", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "d" - ], - "description": "The description of the transform.", - "name": "description", + "name": "hidden", + "required": false, + "serverDefault": "false", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "auto_expand_replicas", "required": false, + "serverDefault": "false", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "WithNullValue", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "tt" - ], - "description": "The type of transform: `batch` or `continuous`.", - "name": "transform_type", + "name": "merge", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Merge", + "namespace": "indices._types" } } }, { - "aliases": [ - "f" - ], - "description": "The interval between checks for changes in the source indices when the transform is running continuously.", - "name": "frequency", + "name": "search", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SettingsSearch", + "namespace": "indices._types" } } }, { - "aliases": [ - "mpsz" - ], - "description": "The initial page size that is used for the composite aggregation for each checkpoint.", - "name": "max_page_search_size", + "name": "refresh_interval", "required": false, + "serverDefault": "1s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "dps" - ], - "description": "The number of input documents per second.", - "name": "docs_per_second", + "name": "max_result_window", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "r" - ], - "description": "If a transform has a `failed` state, these details describe the reason for failure.", - "name": "reason", + "name": "max_inner_result_window", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "st" - ], - "description": "The total number of search operations on the source index for the transform.", - "name": "search_total", + "name": "max_rescore_window", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "sf" - ], - "description": "The total number of search failures.", - "name": "search_failure", + "name": "max_docvalue_fields_search", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "stime" - ], - "description": "The total amount of search time, in milliseconds.", - "name": "search_time", + "name": "max_script_fields", "required": false, + "serverDefault": 32, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "it" - ], - "description": "The total number of index operations done by the transform.", - "name": "index_total", + "name": "max_ngram_diff", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "if" - ], - "description": "The total number of indexing failures.", - "name": "index_failure", + "name": "max_shingle_diff", "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "itime" - ], - "description": "The total time spent indexing documents, in milliseconds.", - "name": "index_time", + "name": "blocks", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexSettingBlocks", + "namespace": "indices._types" } } }, { - "aliases": [ - "doci" - ], - "description": "The number of documents that have been indexed into the destination index for the transform.", - "name": "documents_indexed", + "name": "max_refresh_listeners", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "dtime" - ], - "description": "The total time spent deleting documents, in milliseconds.", - "name": "delete_time", + "description": "Settings to define analyzers, tokenizers, token filters and character filters.", + "name": "analyze", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SettingsAnalyze", + "namespace": "indices._types" } } }, { - "aliases": [ - "docd" - ], - "description": "The number of documents deleted from the destination index due to the retention policy for the transform.", - "name": "documents_deleted", + "name": "highlight", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SettingsHighlight", + "namespace": "indices._types" } } }, { - "aliases": [ - "tc" - ], - "description": "The number of times the transform has been triggered by the scheduler.\nFor example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property.", - "name": "trigger_count", + "name": "max_terms_count", "required": false, + "serverDefault": 65536, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "pp" - ], - "description": "The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually.", - "name": "pages_processed", + "name": "max_regex_length", "required": false, + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "pt" - ], - "description": "The total time spent processing results, in milliseconds.", - "name": "processing_time", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRouting", + "namespace": "indices._types" } } }, { - "aliases": [ - "cdtea", - "checkpointTimeExpAvg" - ], - "description": "The exponential moving average of the duration of the checkpoint, in milliseconds.", - "name": "checkpoint_duration_time_exp_avg", + "name": "gc_deletes", "required": false, + "serverDefault": "60s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "idea" - ], - "description": "The exponential moving average of the number of new documents that have been indexed.", - "name": "indexed_documents_exp_avg", + "name": "default_pipeline", "required": false, + "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineName", + "namespace": "_types" } } }, { - "aliases": [ - "pdea" - ], - "description": "The exponential moving average of the number of documents that have been processed.", - "name": "processed_documents_exp_avg", + "name": "final_pipeline", "required": false, + "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineName", + "namespace": "_types" } } - } - ], - "specLocation": "cat/transforms/types.ts#L22-L197" - }, - { - "kind": "interface", - "name": { - "name": "ComponentTemplate", - "namespace": "cluster._types" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "name": "lifecycle", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "IndexSettingsLifecycle", + "namespace": "indices._types" } } }, { - "name": "component_template", - "required": true, + "name": "provided_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" + "name": "Name", + "namespace": "_types" } } - } - ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L27-L30" - }, - { - "kind": "interface", - "name": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" - }, - "properties": [ + }, { - "name": "template", - "required": true, + "name": "creation_date", + "required": false, "type": { + "generics": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "ComponentTemplateSummary", - "namespace": "cluster._types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "version", + "name": "creation_date_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "DateTime", "namespace": "_types" } } }, { - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", - "name": "_meta", + "name": "uuid", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Metadata", + "name": "Uuid", "namespace": "_types" } } }, { - "name": "deprecated", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IndexVersioning", + "namespace": "indices._types" } } - } - ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L32-L41" - }, - { - "kind": "interface", - "name": { - "name": "ComponentTemplateSummary", - "namespace": "cluster._types" - }, - "properties": [ + }, { - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", - "name": "_meta", + "name": "verified_before_close", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "version", + "name": "format", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "max_slices_per_scroll", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "integer", "namespace": "_types" } } }, { - "name": "settings", + "name": "translog", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "Translog", + "namespace": "indices._types" } } }, { - "name": "mappings", + "name": "query_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "SettingsQueryString", + "namespace": "indices._types" } } }, { - "name": "aliases", + "name": "priority", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AliasDefinition", - "namespace": "indices._types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } + ], + "kind": "union_of" } }, { - "availability": { - "serverless": { - "stability": "stable" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" + "name": "top_metrics_max_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } - }, - "name": "lifecycle", + } + }, + { + "name": "analysis", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleWithRollover", + "name": "IndexSettingsAnalysis", "namespace": "indices._types" } } - } - ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L43-L55" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "user_defined_value" - } - ], - "meta": { - "description": "Additional settings not covered in this type.", - "fieldname": "other_settings" - }, + "name": "settings", + "required": false, "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } } - } - ], - "docId": "index-modules-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html#index-modules-settings", - "kind": "interface", - "name": { - "name": "IndexSettings", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "index", + "name": "time_series", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", + "name": "IndexSettingsTimeSeries", "namespace": "indices._types" } } }, { - "name": "mode", + "name": "queries", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Queries", + "namespace": "indices._types" } } }, { - "name": "routing_path", + "description": "Configure custom similarity settings to customize how search results are scored.", + "name": "similarity", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "SettingsSimilarity", + "namespace": "indices._types" } - ], - "kind": "union_of" + } } }, { - "name": "soft_deletes", + "description": "Enable or disable dynamic mapping for an index.", + "name": "mapping", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SoftDeletes", + "name": "MappingLimitSettings", "namespace": "indices._types" } } }, { - "name": "sort", + "name": "indexing.slowlog", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSegmentSort", + "name": "IndexingSlowlogSettings", "namespace": "indices._types" } } }, { - "name": "number_of_routing_shards", + "description": "Configure indexing back pressure limits.", + "name": "indexing_pressure", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexingPressure", + "namespace": "indices._types" } } }, { - "name": "check_on_startup", + "description": "The store module allows you to control how index data is stored and accessed on disk.", + "name": "store", "required": false, - "serverDefault": "false", "type": { "kind": "instance_of", "type": { - "name": "IndexCheckOnStartup", + "name": "Storage", "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L70-L176" + }, + { + "kind": "interface", + "name": { + "name": "SoftDeletes", + "namespace": "indices._types" + }, + "properties": [ { - "name": "codec", + "description": "Indicates whether soft deletes are enabled on the index.", + "name": "enabled", "required": false, - "serverDefault": "LZ4", + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "routing_partition_size", + "description": "The maximum period to retain a shard history retention lease before it is considered expired.\nShard history retention leases ensure that soft deletes are retained during merges on the Lucene\nindex. If a soft delete is merged away before it can be replicated to a follower the following\nprocess will fail due to incomplete history on the leader.", + "name": "retention_lease", "required": false, - "serverDefault": "1", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "RetentionLease", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L51-L64" + }, + { + "kind": "interface", + "name": { + "name": "RetentionLease", + "namespace": "indices._types" + }, + "properties": [ { - "name": "load_fixed_bitset_filters_eagerly", + "name": "period", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L66-L68" + }, + { + "kind": "interface", + "name": { + "name": "IndexSegmentSort", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "field", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Fields", + "namespace": "_types" } } }, { - "name": "hidden", + "name": "order", "required": false, - "serverDefault": "false", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SegmentSortOrder", + "namespace": "indices._types" } }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortOrder", + "namespace": "indices._types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "name": "mode", + "required": false, + "type": { + "items": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SegmentSortMode", + "namespace": "indices._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortMode", + "namespace": "indices._types" + } } } ], @@ -113996,100 +107299,180 @@ } }, { - "name": "auto_expand_replicas", + "name": "missing", "required": false, - "serverDefault": "false", "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SegmentSortMissing", + "namespace": "indices._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortMissing", + "namespace": "indices._types" + } } } ], + "kind": "union_of" + } + } + ], + "specLocation": "indices/_types/IndexSegmentSort.ts#L22-L27" + }, + { + "kind": "interface", + "name": { + "name": "Merge", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "scheduler", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "WithNullValue", - "namespace": "_spec_utils" + "name": "MergeScheduler", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L346-L348" + }, + { + "kind": "interface", + "name": { + "name": "MergeScheduler", + "namespace": "indices._types" + }, + "properties": [ { - "name": "merge", + "name": "max_thread_count", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "Merge", - "namespace": "indices._types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "search", + "name": "max_merge_count", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "SettingsSearch", - "namespace": "indices._types" + "name": "Stringified", + "namespace": "_spec_utils" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L350-L353" + }, + { + "kind": "interface", + "name": { + "name": "SettingsSearch", + "namespace": "indices._types" + }, + "properties": [ { - "name": "refresh_interval", + "name": "idle", "required": false, - "serverDefault": "1s", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "SearchIdle", + "namespace": "indices._types" } } }, { - "name": "max_result_window", + "name": "slowlog", "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "SlowlogSettings", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L248-L251" + }, + { + "kind": "interface", + "name": { + "name": "SearchIdle", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_inner_result_window", + "name": "after", "required": false, - "serverDefault": 100, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Duration", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L253-L256" + }, + { + "kind": "interface", + "name": { + "name": "SlowlogSettings", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_rescore_window", + "name": "level", "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_docvalue_fields_search", + "name": "source", "required": false, - "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -114099,330 +107482,435 @@ } }, { - "name": "max_script_fields", + "name": "reformat", "required": false, - "serverDefault": 32, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "max_ngram_diff", + "name": "threshold", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "SlowlogTresholds", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L515-L520" + }, + { + "kind": "interface", + "name": { + "name": "SlowlogTresholds", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_shingle_diff", + "name": "query", "required": false, - "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" } } }, { - "name": "blocks", + "name": "fetch", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettingBlocks", + "name": "SlowlogTresholdLevels", "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L522-L525" + }, + { + "kind": "interface", + "name": { + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_refresh_listeners", + "name": "warn", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Duration", "namespace": "_types" } } }, { - "description": "Settings to define analyzers, tokenizers, token filters and character filters.", - "name": "analyze", + "name": "info", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SettingsAnalyze", - "namespace": "indices._types" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "highlight", + "name": "debug", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SettingsHighlight", - "namespace": "indices._types" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "max_terms_count", + "name": "trace", "required": false, - "serverDefault": 65536, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Duration", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L527-L532" + }, + { + "kind": "interface", + "name": { + "name": "IndexSettingBlocks", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_regex_length", + "name": "read_only", "required": false, - "serverDefault": 1000, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "routing", + "name": "read_only_allow_delete", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "IndexRouting", - "namespace": "indices._types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "gc_deletes", + "name": "read", "required": false, - "serverDefault": "60s", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "default_pipeline", + "name": "write", "required": false, - "serverDefault": "_none", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "PipelineName", - "namespace": "_types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "final_pipeline", + "name": "metadata", "required": false, - "serverDefault": "_none", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "PipelineName", - "namespace": "_types" + "name": "Stringified", + "namespace": "_spec_utils" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L262-L268" + }, + { + "kind": "interface", + "name": { + "name": "SettingsAnalyze", + "namespace": "indices._types" + }, + "properties": [ { - "name": "lifecycle", + "name": "max_token_count", "required": false, + "serverDefault": "10000", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "IndexSettingsLifecycle", - "namespace": "indices._types" + "name": "Stringified", + "namespace": "_spec_utils" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L243-L246" + }, + { + "kind": "interface", + "name": { + "name": "SettingsHighlight", + "namespace": "indices._types" + }, + "properties": [ { - "name": "provided_name", + "name": "max_analyzed_offset", "required": false, + "serverDefault": 1000000, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L238-L241" + }, + { + "kind": "interface", + "name": { + "name": "IndexRouting", + "namespace": "indices._types" + }, + "properties": [ { - "name": "creation_date", + "name": "allocation", "required": false, "type": { - "generics": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "IndexRoutingAllocation", + "namespace": "indices._types" } } }, { - "name": "creation_date_string", + "name": "rebalance", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "IndexRoutingRebalance", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L22-L25" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingAllocation", + "namespace": "indices._types" + }, + "properties": [ { - "name": "uuid", + "name": "enable", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "IndexRoutingAllocationOptions", + "namespace": "indices._types" } } }, { - "name": "version", + "name": "include", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexVersioning", + "name": "IndexRoutingAllocationInclude", "namespace": "indices._types" } } }, { - "name": "verified_before_close", + "name": "initial_recovery", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "IndexRoutingAllocationInitialRecovery", + "namespace": "indices._types" + } } }, { - "name": "format", + "name": "disk", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "IndexRoutingAllocationDisk", + "namespace": "indices._types" + } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L27-L32" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingAllocationInclude", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_slices_per_scroll", + "name": "_tier_preference", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "translog", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Translog", - "namespace": "indices._types" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L52-L55" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingAllocationInitialRecovery", + "namespace": "indices._types" + }, + "properties": [ { - "name": "query_string", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SettingsQueryString", - "namespace": "indices._types" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L57-L59" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingAllocationDisk", + "namespace": "indices._types" + }, + "properties": [ { - "name": "priority", + "name": "threshold_enabled", "required": false, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } }, { @@ -114435,348 +107923,316 @@ ], "kind": "union_of" } - }, - { - "name": "top_metrics_max_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "analysis", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettingsAnalysis", - "namespace": "indices._types" - } - } - }, - { - "name": "settings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L62-L64" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingRebalance", + "namespace": "indices._types" + }, + "properties": [ { - "name": "time_series", - "required": false, + "name": "enable", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexSettingsTimeSeries", + "name": "IndexRoutingRebalanceOptions", "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L34-L36" + }, + { + "kind": "interface", + "name": { + "name": "IndexSettingsLifecycle", + "namespace": "indices._types" + }, + "properties": [ { - "name": "queries", + "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Queries", - "namespace": "indices._types" + "name": "Name", + "namespace": "_types" } } }, { - "description": "Configure custom similarity settings to customize how search results are scored.", - "name": "similarity", + "description": "Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.\nYou can explicitly set it to skip rollover.", + "name": "indexing_complete", "required": false, + "serverDefault": "false", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarity", - "namespace": "indices._types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } + ], + "kind": "instance_of", + "type": { + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "description": "Enable or disable dynamic mapping for an index.", - "name": "mapping", + "description": "If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting\nif you create a new index that contains old data and want to use the original creation date to calculate the index\nage. Specified as a Unix epoch value in milliseconds.", + "name": "origination_date", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettings", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "indexing.slowlog", + "description": "Set to true to parse the origination date from the index name. This origination date is used to calculate the index age\nfor its phase transitions. The index name must match the pattern ^.*-{date_format}-\\\\d+, where the date_format is\nyyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,\nfor example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.", + "name": "parse_origination_date", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexingSlowlogSettings", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Configure indexing back pressure limits.", - "name": "indexing_pressure", + "name": "step", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexingPressure", + "name": "IndexSettingsLifecycleStep", "namespace": "indices._types" } } }, { - "description": "The store module allows you to control how index data is stored and accessed on disk.", - "name": "store", + "description": "The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.\nWhen the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more\ninformation about rolling indices, see Rollover.", + "name": "rollover_alias", "required": false, + "serverDefault": "", "type": { "kind": "instance_of", "type": { - "name": "Storage", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } + }, + { + "description": "Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are\napplicable for an index).", + "name": "prefer_ilm", + "required": false, + "serverDefault": "true", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } } ], - "specLocation": "indices/_types/IndexSettings.ts#L70-L176" + "specLocation": "indices/_types/IndexSettings.ts#L284-L323" }, { "kind": "interface", "name": { - "name": "SoftDeletes", + "name": "IndexSettingsLifecycleStep", "namespace": "indices._types" }, "properties": [ { - "description": "Indicates whether soft deletes are enabled on the index.", - "name": "enabled", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The maximum period to retain a shard history retention lease before it is considered expired.\nShard history retention leases ensure that soft deletes are retained during merges on the Lucene\nindex. If a soft delete is merged away before it can be replicated to a follower the following\nprocess will fail due to incomplete history on the leader.", - "name": "retention_lease", + "description": "Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).\nSee Shard allocation for shrink.", + "name": "wait_time_threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RetentionLease", - "namespace": "indices._types" + "name": "Duration", + "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L51-L64" + "specLocation": "indices/_types/IndexSettings.ts#L325-L331" }, { "kind": "interface", "name": { - "name": "RetentionLease", + "name": "IndexVersioning", "namespace": "indices._types" }, "properties": [ { - "name": "period", - "required": true, + "name": "created", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "VersionString", "namespace": "_types" } } + }, + { + "name": "created_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "indices/_types/IndexSettings.ts#L66-L68" + "specLocation": "indices/_types/IndexSettings.ts#L279-L282" }, { "kind": "interface", "name": { - "name": "IndexSegmentSort", + "name": "Translog", "namespace": "indices._types" }, "properties": [ { - "name": "field", + "description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.", + "name": "sync_interval", "required": false, + "serverDefault": "5s", "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Duration", "namespace": "_types" } } }, { - "name": "order", + "description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.", + "name": "durability", "required": false, + "serverDefault": "string", "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "SegmentSortOrder", - "namespace": "indices._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SegmentSortOrder", - "namespace": "indices._types" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TranslogDurability", + "namespace": "indices._types" + } } }, { - "name": "mode", + "description": "The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not\npart of a Lucene commit point). Although these operations are available for reads, they will need\nto be replayed if the shard was stopped and had to be recovered. This setting controls the\nmaximum total size of these operations, to prevent recoveries from taking too long. Once the\nmaximum size has been reached a flush will happen, generating a new Lucene commit point.", + "name": "flush_threshold_size", "required": false, + "serverDefault": "512mb", "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "SegmentSortMode", - "namespace": "indices._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SegmentSortMode", - "namespace": "indices._types" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } } }, { - "name": "missing", + "name": "retention", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "SegmentSortMissing", - "namespace": "indices._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SegmentSortMissing", - "namespace": "indices._types" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TranslogRetention", + "namespace": "indices._types" + } } } ], - "specLocation": "indices/_types/IndexSegmentSort.ts#L22-L27" + "specLocation": "indices/_types/IndexSettings.ts#L355-L377" }, { "kind": "interface", "name": { - "name": "Merge", + "name": "TranslogRetention", "namespace": "indices._types" }, "properties": [ { - "name": "scheduler", + "description": "This controls the total size of translog files to keep for each shard. Keeping more translog files increases\nthe chance of performing an operation based sync when recovering a replica. If the translog files are not\nsufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be\nset, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch\nversions 7.0.0 and later.", + "name": "size", "required": false, + "serverDefault": "512mb", "type": { "kind": "instance_of", "type": { - "name": "MergeScheduler", - "namespace": "indices._types" + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "description": "This controls the maximum duration for which translog files are kept by each shard. Keeping more\ntranslog files increases the chance of performing an operation based sync when recovering replicas. If\nthe translog files are not sufficient, replica recovery will fall back to a file based sync. This setting\nis ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in\nindices created in Elasticsearch versions 7.0.0 and later.", + "name": "age", + "required": false, + "serverDefault": "12h", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L346-L348" + "specLocation": "indices/_types/IndexSettings.ts#L396-L415" }, { "kind": "interface", "name": { - "name": "MergeScheduler", + "name": "SettingsQueryString", "namespace": "indices._types" }, "properties": [ { - "name": "max_thread_count", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } - } - }, - { - "name": "max_merge_count", - "required": false, + "name": "lenient", + "required": true, "type": { "generics": [ { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } ], @@ -114788,615 +108244,551 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L350-L353" + "specLocation": "indices/_types/IndexSettings.ts#L258-L260" }, { "kind": "interface", "name": { - "name": "SettingsSearch", + "name": "IndexSettingsAnalysis", "namespace": "indices._types" }, "properties": [ { - "name": "idle", + "name": "analyzer", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SearchIdle", - "namespace": "indices._types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Analyzer", + "namespace": "_types.analysis" + } } } }, { - "name": "slowlog", + "name": "char_filter", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SlowlogSettings", - "namespace": "indices._types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "CharFilter", + "namespace": "_types.analysis" + } } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L248-L251" - }, - { - "kind": "interface", - "name": { - "name": "SearchIdle", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "after", + "name": "filter", "required": false, - "serverDefault": "30s", "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "TokenFilter", + "namespace": "_types.analysis" + } } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L253-L256" - }, - { - "kind": "interface", - "name": { - "name": "SlowlogSettings", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "level", + "name": "normalizer", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Normalizer", + "namespace": "_types.analysis" + } } } }, { - "name": "source", + "name": "tokenizer", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Tokenizer", + "namespace": "_types.analysis" + } } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L333-L339" + }, + { + "kind": "interface", + "name": { + "name": "IndexSettingsTimeSeries", + "namespace": "indices._types" + }, + "properties": [ { - "name": "reformat", + "name": "end_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "name": "threshold", + "name": "start_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SlowlogTresholds", - "namespace": "indices._types" + "name": "DateTime", + "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L515-L520" + "specLocation": "indices/_types/IndexSettings.ts#L341-L344" }, { "kind": "interface", "name": { - "name": "SlowlogTresholds", + "name": "Queries", "namespace": "indices._types" }, "properties": [ { - "name": "query", + "name": "cache", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SlowlogTresholdLevels", + "name": "CacheQueries", "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L417-L419" + }, + { + "kind": "interface", + "name": { + "name": "CacheQueries", + "namespace": "indices._types" + }, + "properties": [ { - "name": "fetch", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SlowlogTresholdLevels", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L522-L525" + "specLocation": "indices/_types/IndexSettings.ts#L421-L423" }, { + "description": "Mapping Limit Settings", + "docId": "mapping-settings-limit", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html", "kind": "interface", "name": { - "name": "SlowlogTresholdLevels", + "name": "MappingLimitSettings", "namespace": "indices._types" }, "properties": [ { - "name": "warn", + "name": "coerce", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "info", + "name": "total_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "MappingLimitSettingsTotalFields", + "namespace": "indices._types" } } }, { - "name": "debug", + "name": "depth", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "MappingLimitSettingsDepth", + "namespace": "indices._types" } } }, { - "name": "trace", + "name": "nested_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "MappingLimitSettingsNestedFields", + "namespace": "indices._types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L527-L532" - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingBlocks", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "read_only", + "name": "nested_objects", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "MappingLimitSettingsNestedObjects", + "namespace": "indices._types" + } + } + }, + { + "name": "field_name_length", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MappingLimitSettingsFieldNameLength", + "namespace": "indices._types" } } }, { - "name": "read_only_allow_delete", + "name": "dimension_fields", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "MappingLimitSettingsDimensionFields", + "namespace": "indices._types" } } }, { - "name": "read", + "name": "source", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "MappingLimitSettingsSourceFields", + "namespace": "indices._types" } } }, { - "name": "write", + "name": "ignore_malformed", "required": false, "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } - } - ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } - } - }, - { - "name": "metadata", - "required": false, - "type": { - "generics": [ + }, { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } + "kind": "union_of" } } ], - "specLocation": "indices/_types/IndexSettings.ts#L262-L268" + "specLocation": "indices/_types/IndexSettings.ts#L425-L439" }, { "kind": "interface", "name": { - "name": "SettingsAnalyze", + "name": "MappingLimitSettingsTotalFields", "namespace": "indices._types" }, "properties": [ { - "name": "max_token_count", + "description": "The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.\nThe limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance\ndegradations and memory issues, especially in clusters with a high load or few resources.", + "name": "limit", "required": false, - "serverDefault": "10000", + "serverDefault": "1000", "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } + "kind": "union_of" } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L243-L246" - }, - { - "kind": "interface", - "name": { - "name": "SettingsHighlight", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "max_analyzed_offset", + "description": "This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set\nto false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail\nwith the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.\nInstead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.\nThe fields that were not added to the mapping will be added to the _ignored field.", + "name": "ignore_dynamic_beyond_limit", "required": false, - "serverDefault": 1000000, + "serverDefault": "false", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } } ], - "specLocation": "indices/_types/IndexSettings.ts#L238-L241" + "specLocation": "indices/_types/IndexSettings.ts#L441-L458" }, { "kind": "interface", "name": { - "name": "IndexRouting", + "name": "MappingLimitSettingsDepth", "namespace": "indices._types" }, "properties": [ { - "name": "allocation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexRoutingAllocation", - "namespace": "indices._types" - } - } - }, - { - "name": "rebalance", + "description": "The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined\nat the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.", + "name": "limit", "required": false, + "serverDefault": 20, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingRebalance", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexRouting.ts#L22-L25" + "specLocation": "indices/_types/IndexSettings.ts#L460-L467" }, { "kind": "interface", "name": { - "name": "IndexRoutingAllocation", + "name": "MappingLimitSettingsNestedFields", "namespace": "indices._types" }, "properties": [ { - "name": "enable", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexRoutingAllocationOptions", - "namespace": "indices._types" - } - } - }, - { - "name": "include", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexRoutingAllocationInclude", - "namespace": "indices._types" - } - } - }, - { - "name": "initial_recovery", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexRoutingAllocationInitialRecovery", - "namespace": "indices._types" - } - } - }, - { - "name": "disk", + "description": "The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when\narrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this\nsetting limits the number of unique nested types per index.", + "name": "limit", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationDisk", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexRouting.ts#L27-L32" + "specLocation": "indices/_types/IndexSettings.ts#L469-L477" }, { "kind": "interface", "name": { - "name": "IndexRoutingAllocationInclude", + "name": "MappingLimitSettingsNestedObjects", "namespace": "indices._types" }, "properties": [ { - "name": "_tier_preference", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "_id", + "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps\nto prevent out of memory errors when a document contains too many nested objects.", + "name": "limit", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexRouting.ts#L52-L55" + "specLocation": "indices/_types/IndexSettings.ts#L479-L486" }, { "kind": "interface", "name": { - "name": "IndexRoutingAllocationInitialRecovery", + "name": "MappingLimitSettingsFieldNameLength", "namespace": "indices._types" }, "properties": [ { - "name": "_id", + "description": "Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but\nmight still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The\ndefault is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).", + "name": "limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexRouting.ts#L57-L59" + "specLocation": "indices/_types/IndexSettings.ts#L488-L495" }, { "kind": "interface", "name": { - "name": "IndexRoutingAllocationDisk", + "name": "MappingLimitSettingsDimensionFields", "namespace": "indices._types" }, "properties": [ { - "name": "threshold_enabled", + "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release.\nElastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.", + "name": "limit", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } } ], - "specLocation": "indices/_types/IndexRouting.ts#L62-L64" + "specLocation": "indices/_types/IndexSettings.ts#L497-L503" }, { "kind": "interface", "name": { - "name": "IndexRoutingRebalance", + "name": "MappingLimitSettingsSourceFields", "namespace": "indices._types" }, "properties": [ { - "name": "enable", + "name": "mode", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingRebalanceOptions", + "name": "SourceMode", "namespace": "indices._types" } } } ], - "specLocation": "indices/_types/IndexRouting.ts#L34-L36" + "specLocation": "indices/_types/IndexSettings.ts#L505-L507" }, { "kind": "interface", "name": { - "name": "IndexSettingsLifecycle", + "name": "IndexingSlowlogSettings", "namespace": "indices._types" }, "properties": [ { - "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.", - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "description": "Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.\nYou can explicitly set it to skip rollover.", - "name": "indexing_complete", + "name": "level", "required": false, - "serverDefault": "false", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting\nif you create a new index that contains old data and want to use the original creation date to calculate the index\nage. Specified as a Unix epoch value in milliseconds.", - "name": "origination_date", + "name": "source", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "description": "Set to true to parse the origination date from the index name. This origination date is used to calculate the index age\nfor its phase transitions. The index name must match the pattern ^.*-{date_format}-\\\\d+, where the date_format is\nyyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,\nfor example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.", - "name": "parse_origination_date", + "name": "reformat", "required": false, "type": { "kind": "instance_of", @@ -115407,253 +108799,253 @@ } }, { - "name": "step", + "name": "threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettingsLifecycleStep", + "name": "IndexingSlowlogTresholds", "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L588-L593" + }, + { + "kind": "interface", + "name": { + "name": "IndexingSlowlogTresholds", + "namespace": "indices._types" + }, + "properties": [ { - "description": "The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.\nWhen the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more\ninformation about rolling indices, see Rollover.", - "name": "rollover_alias", + "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.", + "docId": "index-modules-slowlog-slowlog", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-slowlog.html#index-slow-log", + "name": "index", "required": false, - "serverDefault": "", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L595-L602" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressure", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are\napplicable for an index).", - "name": "prefer_ilm", - "required": false, - "serverDefault": "true", + "name": "memory", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "IndexingPressureMemory", + "namespace": "indices._types" + } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L284-L323" + "specLocation": "indices/_types/IndexSettings.ts#L575-L577" }, { "kind": "interface", "name": { - "name": "IndexSettingsLifecycleStep", + "name": "IndexingPressureMemory", "namespace": "indices._types" }, "properties": [ { - "description": "Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).\nSee Shard allocation for shrink.", - "name": "wait_time_threshold", + "description": "Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,\nthe node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,\nthe node will reject new replica operations. Defaults to 10% of the heap.", + "name": "limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L325-L331" + "specLocation": "indices/_types/IndexSettings.ts#L579-L586" }, { "kind": "interface", "name": { - "name": "IndexVersioning", + "name": "Storage", "namespace": "indices._types" }, "properties": [ { - "name": "created", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "StorageType", + "namespace": "indices._types" } } }, { - "name": "created_string", + "description": "You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.\nThis is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This\nsetting is useful, for example, if you are in an environment where you can not control the ability to create a lot\nof memory maps so you need disable the ability to use memory-mapping.", + "name": "allow_mmap", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L279-L282" + "specLocation": "indices/_types/IndexSettings.ts#L534-L543" }, { "kind": "interface", "name": { - "name": "Translog", - "namespace": "indices._types" + "name": "TypeMapping", + "namespace": "_types.mapping" }, "properties": [ { - "description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.", - "name": "sync_interval", + "name": "all_field", "required": false, - "serverDefault": "5s", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "AllField", + "namespace": "_types.mapping" } } }, { - "description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.", - "name": "durability", + "name": "date_detection", "required": false, - "serverDefault": "string", "type": { "kind": "instance_of", "type": { - "name": "TranslogDurability", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not\npart of a Lucene commit point). Although these operations are available for reads, they will need\nto be replayed if the shard was stopped and had to be recovered. This setting controls the\nmaximum total size of these operations, to prevent recoveries from taking too long. Once the\nmaximum size has been reached a flush will happen, generating a new Lucene commit point.", - "name": "flush_threshold_size", + "name": "dynamic", "required": false, - "serverDefault": "512mb", "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "DynamicMapping", + "namespace": "_types.mapping" } } }, { - "name": "retention", + "name": "dynamic_date_formats", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "TranslogRetention", - "namespace": "indices._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L355-L377" - }, - { - "kind": "interface", - "name": { - "name": "TranslogRetention", - "namespace": "indices._types" - }, - "properties": [ + }, { - "description": "This controls the total size of translog files to keep for each shard. Keeping more translog files increases\nthe chance of performing an operation based sync when recovering a replica. If the translog files are not\nsufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be\nset, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch\nversions 7.0.0 and later.", - "name": "size", + "name": "dynamic_templates", + "required": false, + "type": { + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "DynamicTemplate", + "namespace": "_types.mapping" + } + } + } + } + }, + { + "name": "_field_names", "required": false, - "serverDefault": "512mb", "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "FieldNamesField", + "namespace": "_types.mapping" } } }, { - "description": "This controls the maximum duration for which translog files are kept by each shard. Keeping more\ntranslog files increases the chance of performing an operation based sync when recovering replicas. If\nthe translog files are not sufficient, replica recovery will fall back to a file based sync. This setting\nis ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in\nindices created in Elasticsearch versions 7.0.0 and later.", - "name": "age", + "name": "index_field", "required": false, - "serverDefault": "12h", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "IndexField", + "namespace": "_types.mapping" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L396-L415" - }, - { - "kind": "interface", - "name": { - "name": "SettingsQueryString", - "namespace": "indices._types" - }, - "properties": [ + }, + { + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } + }, { - "name": "lenient", - "required": true, + "name": "numeric_detection", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L258-L260" - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingsAnalysis", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "analyzer", + "name": "properties", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PropertyName", + "namespace": "_types" } }, "kind": "dictionary_of", @@ -115661,80 +109053,47 @@ "value": { "kind": "instance_of", "type": { - "name": "Analyzer", - "namespace": "_types.analysis" + "name": "Property", + "namespace": "_types.mapping" } } } }, { - "name": "char_filter", + "name": "_routing", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "CharFilter", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "RoutingField", + "namespace": "_types.mapping" } } }, { - "name": "filter", + "name": "_size", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "TokenFilter", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "SizeField", + "namespace": "_types.mapping" } } }, { - "name": "normalizer", + "name": "_source", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Normalizer", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "SourceField", + "namespace": "_types.mapping" } } }, { - "name": "tokenizer", + "name": "runtime", "required": false, "type": { "key": { @@ -115749,75 +109108,72 @@ "value": { "kind": "instance_of", "type": { - "name": "Tokenizer", - "namespace": "_types.analysis" + "name": "RuntimeField", + "namespace": "_types.mapping" } } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L333-L339" - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingsTimeSeries", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "end_time", + "name": "enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "start_time", + "name": "subobjects", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L341-L344" - }, - { - "kind": "interface", - "name": { - "name": "Queries", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "cache", + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "_data_stream_timestamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CacheQueries", - "namespace": "indices._types" + "name": "DataStreamTimestamp", + "namespace": "_types.mapping" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L417-L419" + "specLocation": "_types/mapping/TypeMapping.ts#L34-L57" }, { "kind": "interface", "name": { - "name": "CacheQueries", - "namespace": "indices._types" + "name": "AllField", + "namespace": "_types.mapping" }, "properties": [ + { + "name": "analyzer", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "name": "enabled", "required": true, @@ -115828,23 +109184,10 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L421-L423" - }, - { - "description": "Mapping Limit Settings", - "docId": "mapping-settings-limit", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html", - "kind": "interface", - "name": { - "name": "MappingLimitSettings", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "coerce", - "required": false, + "name": "omit_norms", + "required": true, "type": { "kind": "instance_of", "type": { @@ -115854,134 +109197,162 @@ } }, { - "name": "total_fields", - "required": false, + "name": "search_analyzer", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsTotalFields", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "depth", - "required": false, + "name": "similarity", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsDepth", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "nested_fields", - "required": false, + "name": "store", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsNestedFields", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "nested_objects", - "required": false, + "name": "store_term_vector_offsets", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsNestedObjects", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "field_name_length", - "required": false, + "name": "store_term_vector_payloads", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsFieldNameLength", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "store_term_vector_positions", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "store_term_vectors", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/mapping/meta-fields.ts#L29-L40" + }, + { + "kind": "interface", + "name": { + "name": "DynamicTemplate", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "dimension_fields", + "name": "mapping", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsDimensionFields", - "namespace": "indices._types" + "name": "Property", + "namespace": "_types.mapping" } } }, { - "name": "source", + "name": "runtime", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsSourceFields", - "namespace": "indices._types" + "name": "Property", + "namespace": "_types.mapping" } } }, { - "name": "ignore_malformed", + "containerProperty": true, + "name": "match", "required": false, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } }, { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], "kind": "union_of" } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L425-L439" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsTotalFields", - "namespace": "indices._types" - }, - "properties": [ + }, { - "description": "The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.\nThe limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance\ndegradations and memory issues, especially in clusters with a high load or few resources.", - "name": "limit", + "containerProperty": true, + "name": "path_match", "required": false, - "serverDefault": "1000", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } }, { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], @@ -115989,310 +109360,204 @@ } }, { - "description": "This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set\nto false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail\nwith the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.\nInstead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.\nThe fields that were not added to the mapping will be added to the _ignored field.", - "name": "ignore_dynamic_beyond_limit", + "containerProperty": true, + "name": "unmatch", "required": false, - "serverDefault": "false", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } }, { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], "kind": "union_of" } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L441-L458" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsDepth", - "namespace": "indices._types" - }, - "properties": [ - { - "description": "The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined\nat the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.", - "name": "limit", - "required": false, - "serverDefault": 20, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L460-L467" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsNestedFields", - "namespace": "indices._types" - }, - "properties": [ - { - "description": "The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when\narrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this\nsetting limits the number of unique nested types per index.", - "name": "limit", - "required": false, - "serverDefault": 50, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L469-L477" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsNestedObjects", - "namespace": "indices._types" - }, - "properties": [ - { - "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps\nto prevent out of memory errors when a document contains too many nested objects.", - "name": "limit", - "required": false, - "serverDefault": 10000, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L479-L486" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsFieldNameLength", - "namespace": "indices._types" - }, - "properties": [ - { - "description": "Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but\nmight still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The\ndefault is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).", - "name": "limit", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L488-L495" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsDimensionFields", - "namespace": "indices._types" - }, - "properties": [ - { - "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release.\nElastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.", - "name": "limit", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L497-L503" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsSourceFields", - "namespace": "indices._types" - }, - "properties": [ - { - "name": "mode", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceMode", - "namespace": "indices._types" - } - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L505-L507" - }, - { - "kind": "interface", - "name": { - "name": "IndexingSlowlogSettings", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "level", + "containerProperty": true, + "name": "path_unmatch", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } }, { - "name": "source", + "containerProperty": true, + "name": "match_mapping_type", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } }, { - "name": "reformat", + "containerProperty": true, + "name": "unmatch_mapping_type", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } }, { - "name": "threshold", + "containerProperty": true, + "name": "match_pattern", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexingSlowlogTresholds", - "namespace": "indices._types" + "name": "MatchType", + "namespace": "_types.mapping" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L588-L593" + "specLocation": "_types/mapping/dynamic-template.ts#L22-L42", + "variants": { + "kind": "container" + } }, { "kind": "interface", "name": { - "name": "IndexingSlowlogTresholds", - "namespace": "indices._types" + "name": "FieldNamesField", + "namespace": "_types.mapping" }, "properties": [ { - "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.", - "docId": "index-modules-slowlog-slowlog", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-slowlog.html#index-slow-log", - "name": "index", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SlowlogTresholdLevels", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L595-L602" + "specLocation": "_types/mapping/meta-fields.ts#L42-L44" }, { "kind": "interface", "name": { - "name": "IndexingPressure", - "namespace": "indices._types" + "name": "IndexField", + "namespace": "_types.mapping" }, "properties": [ { - "name": "memory", + "name": "enabled", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexingPressureMemory", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L575-L577" + "specLocation": "_types/mapping/meta-fields.ts#L46-L48" }, { "kind": "interface", "name": { - "name": "IndexingPressureMemory", - "namespace": "indices._types" + "name": "RoutingField", + "namespace": "_types.mapping" }, "properties": [ { - "description": "Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,\nthe node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,\nthe node will reject new replica operations. Defaults to 10% of the heap.", - "name": "limit", - "required": false, + "name": "required", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L579-L586" + "specLocation": "_types/mapping/meta-fields.ts#L50-L52" }, { "kind": "interface", "name": { - "name": "Storage", - "namespace": "indices._types" + "name": "SizeField", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", + "name": "enabled", "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "StorageType", - "namespace": "indices._types" - } - } - }, - { - "description": "You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.\nThis is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This\nsetting is useful, for example, if you are in an environment where you can not control the ability to create a lot\nof memory maps so you need disable the ability to use memory-mapping.", - "name": "allow_mmap", - "required": false, "type": { "kind": "instance_of", "type": { @@ -116302,50 +109567,50 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L534-L543" + "specLocation": "_types/mapping/meta-fields.ts#L54-L56" }, { "kind": "interface", "name": { - "name": "TypeMapping", + "name": "SourceField", "namespace": "_types.mapping" }, "properties": [ { - "name": "all_field", + "name": "compress", "required": false, "type": { "kind": "instance_of", "type": { - "name": "AllField", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "date_detection", + "name": "compress_threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "dynamic", + "name": "enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DynamicMapping", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "dynamic_date_formats", + "name": "excludes", "required": false, "type": { "kind": "array_of", @@ -116359,205 +109624,293 @@ } }, { - "name": "dynamic_templates", + "name": "includes", "required": false, "type": { "kind": "array_of", "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "_field_names", + "name": "mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldNamesField", + "name": "SourceFieldMode", "namespace": "_types.mapping" } } + } + ], + "specLocation": "_types/mapping/meta-fields.ts#L58-L65" + }, + { + "kind": "interface", + "name": { + "name": "DataStreamTimestamp", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "enabled", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/mapping/TypeMapping.ts#L59-L61" + }, + { + "kind": "interface", + "name": { + "name": "AliasDefinition", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "Query used to limit documents the alias can access.", + "name": "filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } }, { - "name": "index_field", + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", + "name": "index_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexField", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", - "name": "_meta", + "description": "If `true`, the index is the write index for the alias.", + "name": "is_write_index", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Value used to route indexing and search operations to a specific shard.", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Metadata", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "numeric_detection", + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", + "name": "search_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "properties", + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", + "name": "is_hidden", "required": false, + "serverDefault": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Property", - "namespace": "_types.mapping" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/_types/AliasDefinition.ts#L22-L54" + }, + { + "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", + "kind": "interface", + "name": { + "name": "DataStreamLifecycleWithRollover", + "namespace": "indices._types" + }, + "properties": [ { - "name": "_routing", + "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": "RoutingField", - "namespace": "_types.mapping" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "_size", + "description": "The downsampling configuration to execute for the managed backing index after rollover.", + "name": "downsampling", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SizeField", - "namespace": "_types.mapping" + "name": "DataStreamLifecycleDownsampling", + "namespace": "indices._types" } } }, { - "name": "_source", + "description": "The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.\nThis property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.\nThe contents of this field are subject to change.", + "name": "rollover", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SourceField", - "namespace": "_types.mapping" + "name": "DataStreamLifecycleRolloverConditions", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/DataStreamLifecycle.ts#L33-L55" + }, + { + "kind": "interface", + "name": { + "name": "DataStreamLifecycleDownsampling", + "namespace": "indices._types" + }, + "properties": [ { - "name": "runtime", - "required": false, + "description": "The list of downsampling rounds to execute as part of this downsampling configuration", + "name": "rounds", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "RuntimeField", - "namespace": "_types.mapping" + "name": "DownsamplingRound", + "namespace": "indices._types" } } } - }, + } + ], + "specLocation": "indices/_types/DataStreamLifecycleDownsampling.ts#L22-L27" + }, + { + "kind": "interface", + "name": { + "name": "DownsamplingRound", + "namespace": "indices._types" + }, + "properties": [ { - "name": "enabled", - "required": false, + "description": "The duration since rollover when this downsampling round should execute", + "name": "after", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "subobjects", - "required": false, + "description": "The downsample configuration to execute.", + "name": "config", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DownsampleConfig", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/DownsamplingRound.ts#L23-L32" + }, + { + "kind": "interface", + "name": { + "name": "DownsampleConfig", + "namespace": "indices._types" + }, + "properties": [ { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "_data_stream_timestamp", - "required": false, + "description": "The interval at which to aggregate the original time series index.", + "name": "fixed_interval", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamTimestamp", - "namespace": "_types.mapping" + "name": "DurationLarge", + "namespace": "_types" } } } ], - "specLocation": "_types/mapping/TypeMapping.ts#L34-L57" + "specLocation": "indices/_types/Downsample.ts#L22-L27" }, { "kind": "interface", "name": { - "name": "AllField", - "namespace": "_types.mapping" + "name": "DataStreamLifecycleRolloverConditions", + "namespace": "indices._types" }, "properties": [ { - "name": "analyzer", - "required": true, + "name": "min_age", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "max_age", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116567,525 +109920,483 @@ } }, { - "name": "enabled", - "required": true, + "name": "min_docs", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "omit_norms", - "required": true, + "name": "max_docs", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "search_analyzer", - "required": true, + "name": "min_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "name": "similarity", - "required": true, + "name": "max_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "name": "store", - "required": true, + "name": "min_primary_shard_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "name": "store_term_vector_offsets", - "required": true, + "name": "max_primary_shard_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "name": "min_primary_shard_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "store_term_vector_payloads", - "required": true, + "name": "max_primary_shard_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/_types/DataStreamLifecycle.ts#L57-L69" + }, + { + "kind": "interface", + "name": { + "name": "Http", + "namespace": "nodes._types" + }, + "properties": [ + { + "description": "Current number of open HTTP connections for the node.", + "name": "current_open", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "store_term_vector_positions", - "required": true, + "description": "Total number of HTTP connections opened for the node.", + "name": "total_opened", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "store_term_vectors", - "required": true, + "description": "Information on current and recently-closed HTTP client connections.\nClients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here.", + "name": "clients", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Client", + "namespace": "nodes._types" + } } } } ], - "specLocation": "_types/mapping/meta-fields.ts#L29-L40" + "specLocation": "nodes/_types/Stats.ts#L669-L688" }, { "kind": "interface", "name": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" + "name": "Client", + "namespace": "nodes._types" }, "properties": [ { - "name": "mapping", + "description": "Unique ID for the HTTP client.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Property", - "namespace": "_types.mapping" + "name": "long", + "namespace": "_types" } } }, { - "name": "runtime", + "description": "Reported agent for the HTTP client.\nIf unavailable, this property is not included in the response.", + "name": "agent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Property", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "containerProperty": true, - "name": "match", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" - } - }, - { - "containerProperty": true, - "name": "path_match", + "description": "Local address for the HTTP connection.", + "name": "local_address", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "containerProperty": true, - "name": "unmatch", + "description": "Remote address for the HTTP connection.", + "name": "remote_address", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "containerProperty": true, - "name": "path_unmatch", + "description": "The URI of the client’s most recent request.", + "name": "last_uri", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "containerProperty": true, - "name": "match_mapping_type", + "description": "Time at which the client opened the connection.", + "name": "opened_time_millis", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } }, { - "containerProperty": true, - "name": "unmatch_mapping_type", + "description": "Time at which the client closed the connection if the connection is closed.", + "name": "closed_time_millis", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } }, { - "containerProperty": true, - "name": "match_pattern", + "description": "Time of the most recent request from this client.", + "name": "last_request_time_millis", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MatchType", - "namespace": "_types.mapping" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/mapping/dynamic-template.ts#L22-L42", - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "FieldNamesField", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "enabled", - "required": true, + "description": "Number of requests from this client.", + "name": "request_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/mapping/meta-fields.ts#L42-L44" - }, - { - "kind": "interface", - "name": { - "name": "IndexField", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "enabled", - "required": true, + "description": "Cumulative size in bytes of all requests from this client.", + "name": "request_size_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/mapping/meta-fields.ts#L46-L48" - }, - { - "kind": "interface", - "name": { - "name": "RoutingField", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "required", - "required": true, + "description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.", + "name": "x_opaque_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "_types/mapping/meta-fields.ts#L50-L52" + "specLocation": "nodes/_types/Stats.ts#L720-L767" }, { "kind": "interface", "name": { - "name": "SizeField", - "namespace": "_types.mapping" + "name": "Ingest", + "namespace": "nodes._types" }, "properties": [ { - "name": "enabled", - "required": true, + "description": "Contains statistics about ingest pipelines for the node.", + "name": "pipelines", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IngestStats", + "namespace": "nodes._types" + } + } + } + }, + { + "description": "Contains statistics about ingest operations for the node.", + "name": "total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IngestTotal", + "namespace": "nodes._types" } } } ], - "specLocation": "_types/mapping/meta-fields.ts#L54-L56" + "specLocation": "nodes/_types/Stats.ts#L345-L354" }, { "kind": "interface", "name": { - "name": "SourceField", - "namespace": "_types.mapping" + "name": "IngestStats", + "namespace": "nodes._types" }, "properties": [ { - "name": "compress", - "required": false, + "description": "Total number of documents ingested during the lifetime of this node.", + "name": "count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "compress_threshold", - "required": false, + "description": "Total number of documents currently being ingested.", + "name": "current", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "enabled", - "required": false, + "description": "Total number of failed ingest operations during the lifetime of this node.", + "name": "failed", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "excludes", - "required": false, + "description": "Total number of ingest processors.", + "name": "processors", + "required": true, "type": { "kind": "array_of", "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "KeyedProcessor", + "namespace": "nodes._types" + } } } } }, { - "name": "includes", - "required": false, + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", + "name": "time_in_millis", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" } } }, { - "name": "mode", - "required": false, + "availability": { + "serverless": {}, + "stack": { + "since": "8.15.0", + "stability": "stable" + } + }, + "description": "Total number of bytes of all documents ingested by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.", + "name": "ingested_as_first_pipeline_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SourceFieldMode", - "namespace": "_types.mapping" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/mapping/meta-fields.ts#L58-L65" - }, - { - "kind": "interface", - "name": { - "name": "DataStreamTimestamp", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "enabled", + "availability": { + "serverless": {}, + "stack": { + "since": "8.15.0", + "stability": "stable" + } + }, + "description": "Total number of bytes of all documents produced by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.\nIn situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.", + "name": "produced_as_first_pipeline_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } } ], - "specLocation": "_types/mapping/TypeMapping.ts#L59-L61" + "specLocation": "nodes/_types/Stats.ts#L356-L394" }, { "kind": "interface", "name": { - "name": "AliasDefinition", - "namespace": "indices._types" + "name": "KeyedProcessor", + "namespace": "nodes._types" }, "properties": [ { - "description": "Query used to limit documents the alias can access.", - "name": "filter", + "name": "stats", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "Processor", + "namespace": "nodes._types" } } }, { - "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", - "name": "index_routing", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -117094,225 +110405,214 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "nodes/_types/Stats.ts#L415-L418" + }, + { + "kind": "interface", + "name": { + "name": "Processor", + "namespace": "nodes._types" + }, + "properties": [ { - "description": "If `true`, the index is the write index for the alias.", - "name": "is_write_index", + "description": "Number of documents transformed by the processor.", + "name": "count", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "description": "Value used to route indexing and search operations to a specific shard.", - "name": "routing", + "description": "Number of documents currently being transformed by the processor.", + "name": "current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", - "name": "search_routing", + "description": "Number of failed operations for the processor.", + "name": "failed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", - "name": "is_hidden", + "description": "Time, in milliseconds, spent by the processor transforming documents.", + "name": "time_in_millis", "required": false, - "serverDefault": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DurationValue", + "namespace": "_types" } } } ], - "specLocation": "indices/_types/AliasDefinition.ts#L22-L54" + "specLocation": "nodes/_types/Stats.ts#L420-L437" }, { - "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", "kind": "interface", "name": { - "name": "DataStreamLifecycleWithRollover", - "namespace": "indices._types" + "name": "IngestTotal", + "namespace": "nodes._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, + "description": "Total number of documents ingested during the lifetime of this node.", + "name": "count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "description": "The downsampling configuration to execute for the managed backing index after rollover.", - "name": "downsampling", - "required": false, + "description": "Total number of documents currently being ingested.", + "name": "current", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleDownsampling", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.\nThis property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.\nThe contents of this field are subject to change.", - "name": "rollover", - "required": false, + "description": "Total number of failed ingest operations during the lifetime of this node.", + "name": "failed", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleRolloverConditions", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/DataStreamLifecycle.ts#L33-L55" - }, - { - "kind": "interface", - "name": { - "name": "DataStreamLifecycleDownsampling", - "namespace": "indices._types" - }, - "properties": [ + }, { - "description": "The list of downsampling rounds to execute as part of this downsampling configuration", - "name": "rounds", + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", + "name": "time_in_millis", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DownsamplingRound", - "namespace": "indices._types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" } } } ], - "specLocation": "indices/_types/DataStreamLifecycleDownsampling.ts#L22-L27" + "specLocation": "nodes/_types/Stats.ts#L396-L413" }, { "kind": "interface", "name": { - "name": "DownsamplingRound", - "namespace": "indices._types" + "name": "ThreadCount", + "namespace": "nodes._types" }, "properties": [ { - "description": "The duration since rollover when this downsampling round should execute", - "name": "after", - "required": true, + "description": "Number of active threads in the thread pool.", + "name": "active", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "description": "The downsample configuration to execute.", - "name": "config", - "required": true, + "description": "Number of tasks completed by the thread pool executor.", + "name": "completed", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DownsampleConfig", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/DownsamplingRound.ts#L23-L32" - }, - { - "kind": "interface", - "name": { - "name": "DownsampleConfig", - "namespace": "indices._types" - }, - "properties": [ + }, { - "description": "The interval at which to aggregate the original time series index.", - "name": "fixed_interval", - "required": true, + "description": "Highest number of active threads in the thread pool.", + "name": "largest", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DurationLarge", + "name": "long", "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/Downsample.ts#L22-L27" - }, - { - "kind": "interface", - "name": { - "name": "DataStreamLifecycleRolloverConditions", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "min_age", + "description": "Number of tasks in queue for the thread pool.", + "name": "queue", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "name": "max_age", + "description": "Number of tasks rejected by the thread pool executor.", + "name": "rejected", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "min_docs", + "description": "Number of threads in the thread pool.", + "name": "threads", "required": false, "type": { "kind": "instance_of", @@ -117321,9 +110621,20 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "nodes/_types/Stats.ts#L1075-L1100" + }, + { + "kind": "interface", + "name": { + "name": "Scripting", + "namespace": "nodes._types" + }, + "properties": [ { - "name": "max_docs", + "description": "Total number of times the script cache has evicted old data.", + "name": "cache_evictions", "required": false, "type": { "kind": "instance_of", @@ -117334,51 +110645,100 @@ } }, { - "name": "min_size", + "description": "Total number of inline script compilations performed by the node.", + "name": "compilations", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "long", "namespace": "_types" } } }, { - "name": "max_size", + "description": "Contains this recent history of script compilations.", + "name": "compilations_history", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + }, + { + "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", + "name": "compilation_limit_triggered", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "long", "namespace": "_types" } } }, { - "name": "min_primary_shard_size", + "name": "contexts", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Context", + "namespace": "nodes._types" + } + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L1048-L1066" + }, + { + "kind": "interface", + "name": { + "name": "Context", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "context", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_primary_shard_size", + "name": "compilations", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "long", "namespace": "_types" } } }, { - "name": "min_primary_shard_docs", + "name": "cache_evictions", "required": false, "type": { "kind": "instance_of", @@ -117389,7 +110749,7 @@ } }, { - "name": "max_primary_shard_docs", + "name": "compilation_limit_triggered", "required": false, "type": { "kind": "instance_of", @@ -117400,7 +110760,7 @@ } } ], - "specLocation": "indices/_types/DataStreamLifecycle.ts#L57-L69" + "specLocation": "nodes/_types/Stats.ts#L1068-L1073" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index 0583215edb..1bd5b01457 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -181958,7 +181958,7 @@ { "kind": "interface", "name": { - "name": "NodeReloadError", + "name": "NodeReloadResult", "namespace": "nodes._types" }, "properties": [ @@ -181985,38 +181985,7 @@ } } ], - "specLocation": "nodes/_types/NodeReloadResult.ts#L24-L27" - }, - { - "kind": "type_alias", - "codegenNames": [ - "stats", - "error" - ], - "name": { - "name": "NodeReloadResult", - "namespace": "nodes._types" - }, - "specLocation": "nodes/_types/NodeReloadResult.ts#L29-L30", - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Stats", - "namespace": "nodes._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NodeReloadError", - "namespace": "nodes._types" - } - } - ] - } + "specLocation": "nodes/_types/NodeReloadResult.ts#L23-L26" }, { "kind": "interface", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index bd9108fb36..3059841d23 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -16819,13 +16819,11 @@ export interface NodesNodeBufferPool { used_in_bytes?: long } -export interface NodesNodeReloadError { +export interface NodesNodeReloadResult { name: Name reload_exception?: ErrorCause } -export type NodesNodeReloadResult = NodesStats | NodesNodeReloadError - export interface NodesNodesResponseBase { _nodes?: NodeStatistics } diff --git a/specification/nodes/_types/NodeReloadResult.ts b/specification/nodes/_types/NodeReloadResult.ts index 498b758d24..e94a656fa8 100644 --- a/specification/nodes/_types/NodeReloadResult.ts +++ b/specification/nodes/_types/NodeReloadResult.ts @@ -17,14 +17,10 @@ * under the License. */ -import { Stats } from '@nodes/_types/Stats' import { Name } from '@_types/common' import { ErrorCause } from '@_types/Errors' -export class NodeReloadError { +export class NodeReloadResult { name: Name reload_exception?: ErrorCause } - -/** @codegen_names stats, error */ -export type NodeReloadResult = Stats | NodeReloadError