@elastic/schemas 0.5.1 → 0.6.0

package/src/es/json/cluster.stats.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cluster.stats__StatsResponseBase":{"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","description":"Contains statistics about the number of nodes selected by the request’s node filters."},"cluster_name":{"type":"string","description":"Name of the cluster, based on the cluster name setting."},"cluster_uuid":{"type":"string","description":"Unique identifier for the cluster."},"indices":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterIndices","description":"Contains statistics about indices with shards assigned to selected nodes."},"nodes":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterNodes","description":"Contains statistics about nodes selected by the request’s node filters."},"repositories":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number"}},"description":"Contains stats on repository feature usage exposed in cluster stats for telemetry."},"snapshots":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterSnapshotStats","description":"Contains stats cluster snapshots."},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"Health status of the cluster, based on the state of its primary and replica shards."},"timestamp":{"type":"number","description":"Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed."},"ccs":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSStats","description":"Cross-cluster stats"}},"required":["cluster_name","cluster_uuid","indices","nodes","repositories","snapshots","timestamp","ccs"]},"cluster.stats__ClusterIndices":{"type":"object","properties":{"analysis":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CharFilterTypes","description":"Contains statistics about analyzers and analyzer components used in selected nodes."},"completion":{"$ref":"./_types.json#/$defs/_types__CompletionStats","description":"Contains statistics about memory used for completion in selected nodes."},"count":{"type":"number","description":"Total number of indices with shards assigned to selected nodes."},"docs":{"$ref":"./_types.json#/$defs/_types__DocStats","description":"Contains counts for documents in selected nodes."},"fielddata":{"$ref":"./_types.json#/$defs/_types__FielddataStats","description":"Contains statistics about the field data cache of selected nodes."},"query_cache":{"$ref":"./_types.json#/$defs/_types__QueryCacheStats","description":"Contains statistics about the query cache of selected nodes."},"search":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SearchUsageStats","description":"Holds a snapshot of the search usage statistics.\nUsed to hold the stats for a single node that's part of a ClusterStatsNodeResponse, as well as to\naccumulate stats for the entire cluster and return them as part of the ClusterStatsResponse."},"segments":{"$ref":"./_types.json#/$defs/_types__SegmentsStats","description":"Contains statistics about segments in selected nodes."},"shards":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterIndicesShards","description":"Contains statistics about indices with shards assigned to selected nodes."},"store":{"$ref":"./_types.json#/$defs/_types__StoreStats","description":"Contains statistics about the size of shards assigned to selected nodes."},"mappings":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypesMappings","description":"Contains statistics about field mappings in selected nodes."},"versions":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__IndicesVersions"},"description":"Contains statistics about analyzers and analyzer components used in selected nodes."},"dense_vector":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__DenseVectorStats","description":"Contains statistics about indexed dense vector"},"sparse_vector":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SparseVectorStats","description":"Contains statistics about indexed sparse vector"}},"required":["completion","count","docs","fielddata","query_cache","search","segments","shards","store","dense_vector","sparse_vector"]},"cluster.stats__CharFilterTypes":{"type":"object","properties":{"analyzer_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about analyzer types used in selected nodes."},"built_in_analyzers":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about built-in analyzers used in selected nodes."},"built_in_char_filters":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about built-in character filters used in selected nodes."},"built_in_filters":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about built-in token filters used in selected nodes."},"built_in_tokenizers":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about built-in tokenizers used in selected nodes."},"char_filter_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about character filter types used in selected nodes."},"multiple_synonym_graph_filters":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__MultipleSynonymGraphFilter"},"filter_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about token filter types used in selected nodes."},"tokenizer_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about tokenizer types used in selected nodes."},"synonyms":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SynonymsStats"},"description":"Contains statistics about synonyms types used in selected nodes."}},"required":["analyzer_types","built_in_analyzers","built_in_char_filters","built_in_filters","built_in_tokenizers","char_filter_types","filter_types","tokenizer_types","synonyms"]},"cluster.stats__FieldTypes":{"type":"object","properties":{"name":{"type":"string","description":"The name for the field type in selected nodes."},"count":{"type":"number","description":"The number of occurrences of the field type in selected nodes."},"index_count":{"type":"number","description":"The number of indices containing the field type in selected nodes."},"indexed_vector_count":{"type":"number","description":"For dense_vector field types, number of indexed vector types in selected nodes."},"indexed_vector_dim_max":{"type":"number","description":"For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes."},"indexed_vector_dim_min":{"type":"number","description":"For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes."},"script_count":{"type":"number","description":"The number of fields that declare a script.","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"vector_index_type_count":{"type":"object","additionalProperties":{"type":"number"},"description":"For dense_vector field types, count of mappings by index type"},"vector_similarity_type_count":{"type":"object","additionalProperties":{"type":"number"},"description":"For dense_vector field types, count of mappings by similarity"},"vector_element_type_count":{"type":"object","additionalProperties":{"type":"number"},"description":"For dense_vector field types, count of mappings by element type"}},"required":["name","count","index_count"]},"cluster.stats__MultipleSynonymGraphFilter":{"type":"object","properties":{"analyzer_count":{"type":"number","description":"Number of analyzers across the cluster whose filter chain contains more than one synonym_graph filter."},"index_count":{"type":"number","description":"Number of indices that contain at least one analyzer with more than one synonym_graph filter."}}},"cluster.stats__SynonymsStats":{"type":"object","properties":{"count":{"type":"number"},"index_count":{"type":"number"}},"required":["count","index_count"]},"cluster.stats__SearchUsageStats":{"type":"object","properties":{"total":{"type":"number"},"queries":{"type":"object","additionalProperties":{"type":"number"}},"rescorers":{"type":"object","additionalProperties":{"type":"number"}},"sections":{"type":"object","additionalProperties":{"type":"number"}},"retrievers":{"type":"object","additionalProperties":{"type":"number"}},"extended":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ExtendedSearchUsage"}},"required":["total","queries","rescorers","sections","retrievers","extended"]},"cluster.stats__ExtendedSearchUsage":{"type":"object","properties":{"retrievers":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ExtendedRetrieversSearchUsage"},"section":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ExtendedSectionSearchUsage"}}},"cluster.stats__ExtendedRetrieversSearchUsage":{"type":"object","properties":{"text_similarity_reranker":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ExtendedTextSimilarityRetrieverUsage"}}},"cluster.stats__ExtendedTextSimilarityRetrieverUsage":{"type":"object","properties":{"chunk_rescorer":{"type":"number"}}},"cluster.stats__ExtendedSectionSearchUsage":{"type":"object","properties":{"sort":{"type":"object","additionalProperties":{"type":"number"}}}},"cluster.stats__ClusterIndicesShards":{"type":"object","properties":{"index":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterIndicesShardsIndex","description":"Contains statistics about shards assigned to selected nodes."},"primaries":{"type":"number","description":"Number of primary shards assigned to selected nodes."},"replication":{"type":"number","description":"Ratio of replica shards to primary shards across all selected nodes."},"total":{"type":"number","description":"Total number of shards assigned to selected nodes."}},"description":"Contains statistics about shards assigned to selected nodes."},"cluster.stats__ClusterIndicesShardsIndex":{"type":"object","properties":{"primaries":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterShardMetrics","description":"Contains statistics about the number of primary shards assigned to selected nodes."},"replication":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterShardMetrics","description":"Contains statistics about the number of replication shards assigned to selected nodes."},"shards":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterShardMetrics","description":"Contains statistics about the number of shards assigned to selected nodes."}},"required":["primaries","replication","shards"]},"cluster.stats__ClusterShardMetrics":{"type":"object","properties":{"avg":{"type":"number","description":"Mean number of shards in an index, counting only shards assigned to selected nodes."},"max":{"type":"number","description":"Maximum number of shards in an index, counting only shards assigned to selected nodes."},"min":{"type":"number","description":"Minimum number of shards in an index, counting only shards assigned to selected nodes."}},"required":["avg","max","min"]},"cluster.stats__FieldTypesMappings":{"type":"object","properties":{"field_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about field data types used in selected nodes."},"runtime_field_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__RuntimeFieldTypes"},"description":"Contains statistics about runtime field data types used in selected nodes."},"total_field_count":{"type":"number","description":"Total number of fields in all non-system indices."},"total_deduplicated_field_count":{"type":"number","description":"Total number of fields in all non-system indices, accounting for mapping deduplication."},"total_deduplicated_mapping_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total size of all mappings after deduplication and compression."},"total_deduplicated_mapping_size_in_bytes":{"type":"number","description":"Total size of all mappings, in bytes, after deduplication and compression."},"source_modes":{"type":"object","additionalProperties":{"type":"number"},"description":"Source mode usage count."}},"required":["field_types","runtime_field_types","source_modes"]},"cluster.stats__RuntimeFieldTypes":{"type":"object","properties":{"chars_max":{"type":"number","description":"Maximum number of characters for a single runtime field script."},"chars_total":{"type":"number","description":"Total number of characters for the scripts that define the current runtime field data type."},"count":{"type":"number","description":"Number of runtime fields mapped to the field data type in selected nodes."},"doc_max":{"type":"number","description":"Maximum number of accesses to doc_values for a single runtime field script"},"doc_total":{"type":"number","description":"Total number of accesses to doc_values for the scripts that define the current runtime field data type."},"index_count":{"type":"number","description":"Number of indices containing a mapping of the runtime field data type in selected nodes."},"lang":{"type":"array","items":{"type":"string"},"description":"Script languages used for the runtime fields scripts."},"lines_max":{"type":"number","description":"Maximum number of lines for a single runtime field script."},"lines_total":{"type":"number","description":"Total number of lines for the scripts that define the current runtime field data type."},"name":{"type":"string","description":"Field data type used in selected nodes."},"scriptless_count":{"type":"number","description":"Number of runtime fields that don’t declare a script."},"shadowed_count":{"type":"number","description":"Number of runtime fields that shadow an indexed field."},"source_max":{"type":"number","description":"Maximum number of accesses to _source for a single runtime field script."},"source_total":{"type":"number","description":"Total number of accesses to _source for the scripts that define the current runtime field data type."}},"required":["chars_max","chars_total","count","doc_max","doc_total","index_count","lang","lines_max","lines_total","name","scriptless_count","shadowed_count","source_max","source_total"]},"cluster.stats__IndicesVersions":{"type":"object","properties":{"index_count":{"type":"number"},"primary_shard_count":{"type":"number"},"total_primary_bytes":{"type":"number"},"total_primary_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"version":{"type":"string"}},"required":["index_count","primary_shard_count","total_primary_bytes","version"]},"cluster.stats__DenseVectorStats":{"type":"object","properties":{"value_count":{"type":"number"},"off_heap":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__DenseVectorOffHeapStats"}},"required":["value_count"]},"cluster.stats__DenseVectorOffHeapStats":{"type":"object","properties":{"total_size_bytes":{"type":"number"},"total_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_veb_size_bytes":{"type":"number"},"total_veb_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_vec_size_bytes":{"type":"number"},"total_vec_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_veq_size_bytes":{"type":"number"},"total_veq_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_vex_size_bytes":{"type":"number"},"total_vex_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_cenivf_size_bytes":{"type":"number"},"total_cenivf_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_clivf_size_bytes":{"type":"number"},"total_clivf_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"fielddata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number"}}}},"required":["total_size_bytes","total_veb_size_bytes","total_vec_size_bytes","total_veq_size_bytes","total_vex_size_bytes","total_cenivf_size_bytes","total_clivf_size_bytes"]},"cluster.stats__SparseVectorStats":{"type":"object","properties":{"value_count":{"type":"number"}},"required":["value_count"]},"cluster.stats__ClusterNodes":{"type":"object","properties":{"count":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterNodeCount","description":"Contains counts for nodes selected by the request’s node filters."},"discovery_types":{"type":"object","additionalProperties":{"type":"number"},"description":"Contains statistics about the discovery types used by selected nodes."},"fs":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterFileSystem","description":"Contains statistics about file stores by selected nodes."},"indexing_pressure":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__IndexingPressure","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}},"ingest":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterIngest"},"jvm":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterJvm","description":"Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes."},"network_types":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterNetworkTypes","description":"Contains statistics about the transport and HTTP networks used by selected nodes."},"os":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterOperatingSystem","description":"Contains statistics about the operating systems used by selected nodes."},"packaging_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__NodePackagingType"},"description":"Contains statistics about Elasticsearch distributions installed on selected nodes."},"plugins":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__PluginStats"},"description":"Contains statistics about installed plugins and modules by selected nodes.\nIf no plugins or modules are installed, this array is empty."},"process":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterProcess","description":"Contains statistics about processes used by selected nodes."},"versions":{"type":"array","items":{"type":"string"},"description":"Array of Elasticsearch versions used on selected nodes."}},"required":["count","discovery_types","fs","indexing_pressure","ingest","jvm","network_types","os","packaging_types","plugins","process","versions"]},"cluster.stats__ClusterNodeCount":{"type":"object","properties":{"total":{"type":"number"},"coordinating_only":{"type":"number"},"data":{"type":"number"},"data_cold":{"type":"number"},"data_content":{"type":"number"},"data_frozen":{"type":"number","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"data_hot":{"type":"number"},"data_warm":{"type":"number"},"index":{"type":"number"},"ingest":{"type":"number"},"master":{"type":"number"},"ml":{"type":"number"},"remote_cluster_client":{"type":"number"},"search":{"type":"number"},"transform":{"type":"number"},"voting_only":{"type":"number"}},"required":["total"]},"cluster.stats__ClusterFileSystem":{"type":"object","properties":{"path":{"type":"string"},"mount":{"type":"string"},"type":{"type":"string"},"available_in_bytes":{"type":"number","description":"Total number of bytes available to JVM in file stores across all selected nodes.\nDepending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.\nThis is the actual amount of free disk space the selected Elasticsearch nodes can use."},"available":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total number of bytes available to JVM in file stores across all selected nodes.\nDepending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.\nThis is the actual amount of free disk space the selected Elasticsearch nodes can use."},"free_in_bytes":{"type":"number","description":"Total number, in bytes, of unallocated bytes in file stores across all selected nodes."},"free":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total number of unallocated bytes in file stores across all selected nodes."},"total_in_bytes":{"type":"number","description":"Total size, in bytes, of all file stores across all selected nodes."},"total":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total size of all file stores across all selected nodes."},"low_watermark_free_space":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"low_watermark_free_space_in_bytes":{"type":"number"},"high_watermark_free_space":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"high_watermark_free_space_in_bytes":{"type":"number"},"flood_stage_free_space":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"flood_stage_free_space_in_bytes":{"type":"number"},"frozen_flood_stage_free_space":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"frozen_flood_stage_free_space_in_bytes":{"type":"number"}}},"cluster.stats__IndexingPressure":{"type":"object","properties":{"memory":{"$ref":"./nodes._types.json#/$defs/nodes._types__IndexingPressureMemory"}},"required":["memory"]},"cluster.stats__ClusterIngest":{"type":"object","properties":{"number_of_pipelines":{"type":"number"},"processor_stats":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterProcessor"}}},"required":["number_of_pipelines","processor_stats"]},"cluster.stats__ClusterProcessor":{"type":"object","properties":{"count":{"type":"number"},"current":{"type":"number"},"failed":{"type":"number"},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_millis":{}},"required":["count","current","failed","time_in_millis"]},"cluster.stats__ClusterJvm":{"type":"object","properties":{"max_uptime_in_millis":{"description":"Uptime duration, in milliseconds, since JVM last started."},"max_uptime":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Uptime duration since JVM last started."},"mem":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterJvmMemory","description":"Contains statistics about memory used by selected nodes."},"threads":{"type":"number","description":"Number of active threads in use by JVM across all selected nodes."},"versions":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterJvmVersion"},"description":"Contains statistics about the JVM versions used by selected nodes."}},"required":["max_uptime_in_millis","mem","threads","versions"]},"cluster.stats__ClusterJvmMemory":{"type":"object","properties":{"heap_max_in_bytes":{"type":"number","description":"Maximum amount of memory, in bytes, available for use by the heap across all selected nodes."},"heap_max":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Maximum amount of memory available for use by the heap across all selected nodes."},"heap_used_in_bytes":{"type":"number","description":"Memory, in bytes, currently in use by the heap across all selected nodes."},"heap_used":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Memory currently in use by the heap across all selected nodes."}},"required":["heap_max_in_bytes","heap_used_in_bytes"]},"cluster.stats__ClusterJvmVersion":{"type":"object","properties":{"bundled_jdk":{"type":"boolean","description":"Always `true`. All distributions come with a bundled Java Development Kit (JDK)."},"count":{"type":"number","description":"Total number of selected nodes using JVM."},"using_bundled_jdk":{"type":"boolean","description":"If `true`, a bundled JDK is in use by JVM."},"version":{"type":"string","description":"Version of JVM used by one or more selected nodes."},"vm_name":{"type":"string","description":"Name of the JVM."},"vm_vendor":{"type":"string","description":"Vendor of the JVM."},"vm_version":{"type":"string","description":"Full version number of JVM.\nThe full version number includes a plus sign (+) followed by the build number."}},"required":["bundled_jdk","count","using_bundled_jdk","version","vm_name","vm_vendor","vm_version"]},"cluster.stats__ClusterNetworkTypes":{"type":"object","properties":{"http_types":{"type":"object","additionalProperties":{"type":"number"},"description":"Contains statistics about the HTTP network types used by selected nodes."},"transport_types":{"type":"object","additionalProperties":{"type":"number"},"description":"Contains statistics about the transport network types used by selected nodes."}},"required":["http_types","transport_types"]},"cluster.stats__ClusterOperatingSystem":{"type":"object","properties":{"allocated_processors":{"type":"number","description":"Number of processors used to calculate thread pool size across all selected nodes.\nThis number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system.\nIn both cases, this number will never be larger than 32."},"architectures":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterOperatingSystemArchitecture"},"description":"Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes."},"available_processors":{"type":"number","description":"Number of processors available to JVM across all selected nodes."},"mem":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__OperatingSystemMemoryInfo","description":"Contains statistics about memory used by selected nodes."},"names":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterOperatingSystemName"},"description":"Contains statistics about operating systems used by selected nodes."},"pretty_names":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterOperatingSystemPrettyName"},"description":"Contains statistics about operating systems used by selected nodes."}},"required":["allocated_processors","available_processors","mem","names","pretty_names"]},"cluster.stats__ClusterOperatingSystemArchitecture":{"type":"object","properties":{"arch":{"type":"string","description":"Name of an architecture used by one or more selected nodes."},"count":{"type":"number","description":"Number of selected nodes using the architecture."}},"required":["arch","count"]},"cluster.stats__OperatingSystemMemoryInfo":{"type":"object","properties":{"adjusted_total_in_bytes":{"type":"number","description":"Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set.","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}},"adjusted_total":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total amount of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set.","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}},"free_in_bytes":{"type":"number","description":"Amount, in bytes, of free physical memory across all selected nodes."},"free":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Amount of free physical memory across all selected nodes."},"free_percent":{"type":"number","description":"Percentage of free physical memory across all selected nodes."},"total_in_bytes":{"type":"number","description":"Total amount, in bytes, of physical memory across all selected nodes."},"total":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total amount of physical memory across all selected nodes."},"used_in_bytes":{"type":"number","description":"Amount, in bytes, of physical memory in use across all selected nodes."},"used":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Amount of physical memory in use across all selected nodes."},"used_percent":{"type":"number","description":"Percentage of physical memory in use across all selected nodes."}},"required":["free_in_bytes","free_percent","total_in_bytes","used_in_bytes","used_percent"]},"cluster.stats__ClusterOperatingSystemName":{"type":"object","properties":{"count":{"type":"number","description":"Number of selected nodes using the operating system."},"name":{"type":"string","description":"Name of an operating system used by one or more selected nodes."}},"required":["count","name"]},"cluster.stats__ClusterOperatingSystemPrettyName":{"type":"object","properties":{"count":{"type":"number","description":"Number of selected nodes using the operating system."},"pretty_name":{"type":"string","description":"Human-readable name of an operating system used by one or more selected nodes."}},"required":["count","pretty_name"]},"cluster.stats__NodePackagingType":{"type":"object","properties":{"count":{"type":"number","description":"Number of selected nodes using the distribution flavor and file type."},"flavor":{"type":"string","description":"Type of Elasticsearch distribution. This is always `default`."},"type":{"type":"string","description":"File type (such as `tar` or `zip`) used for the distribution package."}},"required":["count","flavor","type"]},"cluster.stats__ClusterProcess":{"type":"object","properties":{"cpu":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterProcessCpu","description":"Contains statistics about CPU used by selected nodes."},"open_file_descriptors":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterProcessOpenFileDescriptors","description":"Contains statistics about open file descriptors in selected nodes."}},"required":["cpu","open_file_descriptors"]},"cluster.stats__ClusterProcessCpu":{"type":"object","properties":{"percent":{"type":"number","description":"Percentage of CPU used across all selected nodes.\nReturns `-1` if not supported."}},"required":["percent"]},"cluster.stats__ClusterProcessOpenFileDescriptors":{"type":"object","properties":{"avg":{"type":"number","description":"Average number of concurrently open file descriptors.\nReturns `-1` if not supported."},"max":{"type":"number","description":"Maximum number of concurrently open file descriptors allowed across all selected nodes.\nReturns `-1` if not supported."},"min":{"type":"number","description":"Minimum number of concurrently open file descriptors across all selected nodes.\nReturns -1 if not supported."}},"required":["avg","max","min"]},"cluster.stats__ClusterSnapshotStats":{"type":"object","properties":{"current_counts":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SnapshotCurrentCounts"},"repositories":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__PerRepositoryStats"}}},"required":["current_counts","repositories"]},"cluster.stats__SnapshotCurrentCounts":{"type":"object","properties":{"snapshots":{"type":"number","description":"Snapshots currently in progress"},"shard_snapshots":{"type":"number","description":"Incomplete shard snapshots"},"snapshot_deletions":{"type":"number","description":"Snapshots deletions in progress"},"concurrent_operations":{"type":"number","description":"Sum of snapshots and snapshot_deletions"},"cleanups":{"type":"number","description":"Cleanups in progress, not counted in concurrent_operations as they are not concurrent"}},"required":["snapshots","shard_snapshots","snapshot_deletions","concurrent_operations","cleanups"]},"cluster.stats__PerRepositoryStats":{"type":"object","properties":{"type":{"type":"string"},"oldest_start_time_millis":{"$ref":"./_types.json#/$defs/_types__UnitMillis"},"oldest_start_time":{"type":"string"},"current_counts":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__RepositoryStatsCurrentCounts"}},"required":["type","oldest_start_time_millis","current_counts"]},"cluster.stats__RepositoryStatsCurrentCounts":{"type":"object","properties":{"snapshots":{"type":"number"},"clones":{"type":"number"},"finalizations":{"type":"number"},"deletions":{"type":"number"},"snapshot_deletions":{"type":"number"},"active_deletions":{"type":"number"},"shards":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__RepositoryStatsShards"}},"required":["snapshots","clones","finalizations","deletions","snapshot_deletions","active_deletions","shards"]},"cluster.stats__RepositoryStatsShards":{"type":"object","properties":{"total":{"type":"number"},"complete":{"type":"number"},"incomplete":{"type":"number"},"states":{"type":"object","additionalProperties":{"type":"number"}}},"required":["total","complete","incomplete","states"]},"cluster.stats__CCSStats":{"type":"object","properties":{"clusters":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__RemoteClusterInfo"},"description":"Contains remote cluster settings and metrics collected from them.\nThe keys are cluster names, and the values are per-cluster data.\nOnly present if `include_remotes` option is set to true."},"_search":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageStats","description":"Information about cross-cluster search usage."},"_esql":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageStats","description":"Information about ES|QL cross-cluster query usage."}},"required":["_search"]},"cluster.stats__RemoteClusterInfo":{"type":"object","properties":{"cluster_uuid":{"type":"string","description":"The UUID of the remote cluster."},"mode":{"type":"string","description":"The connection mode used to communicate with the remote cluster."},"skip_unavailable":{"type":"boolean","description":"The `skip_unavailable` setting used for this remote cluster."},"transport.compress":{"type":"string","description":"Transport compression setting used for this remote cluster."},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"Health status of the cluster, based on the state of its primary and replica shards."},"version":{"type":"array","items":{"type":"string"},"description":"The list of Elasticsearch versions used by the nodes on the remote cluster."},"nodes_count":{"type":"number","description":"The total count of nodes in the remote cluster."},"shards_count":{"type":"number","description":"The total number of shards in the remote cluster."},"indices_count":{"type":"number","description":"The total number of indices in the remote cluster."},"indices_total_size_in_bytes":{"type":"number","description":"Total data set size, in bytes, of all shards assigned to selected nodes."},"indices_total_size":{"type":"string","description":"Total data set size of all shards assigned to selected nodes, as a human-readable string."},"max_heap_in_bytes":{"type":"number","description":"Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster."},"max_heap":{"type":"string","description":"Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string."},"mem_total_in_bytes":{"type":"number","description":"Total amount, in bytes, of physical memory across the nodes of the remote cluster."},"mem_total":{"type":"string","description":"Total amount of physical memory across the nodes of the remote cluster, as a human-readable string."}},"required":["cluster_uuid","mode","skip_unavailable","transport.compress","status","version","nodes_count","shards_count","indices_count","indices_total_size_in_bytes","max_heap_in_bytes","mem_total_in_bytes"]},"cluster.stats__CCSUsageStats":{"type":"object","properties":{"total":{"type":"number","description":"The total number of cross-cluster search requests that have been executed by the cluster."},"success":{"type":"number","description":"The total number of cross-cluster search requests that have been successfully executed by the cluster."},"skipped":{"type":"number","description":"The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped."},"took":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageTimeValue","description":"Statistics about the time taken to execute cross-cluster search requests."},"took_mrt_true":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageTimeValue","description":"Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `true`."},"took_mrt_false":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageTimeValue","description":"Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `false`."},"remotes_per_search_max":{"type":"number","description":"The maximum number of remote clusters that were queried in a single cross-cluster search request."},"remotes_per_search_avg":{"type":"number","description":"The average number of remote clusters that were queried in a single cross-cluster search request."},"failure_reasons":{"type":"object","additionalProperties":{"type":"number"},"description":"Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason."},"features":{"type":"object","additionalProperties":{"type":"number"},"description":"The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both `async` and `wildcard`)."},"clients":{"type":"object","additionalProperties":{"type":"number"},"description":"Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as `kibana` or `elasticsearch`) are counted."},"clusters":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageClusterStats"},"description":"Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name `(local)`."}},"required":["total","success","skipped","took","remotes_per_search_max","remotes_per_search_avg","failure_reasons","features","clients","clusters"]},"cluster.stats__CCSUsageTimeValue":{"type":"object","properties":{"max":{"description":"The maximum time taken to execute a request, in milliseconds."},"avg":{"description":"The average time taken to execute a request, in milliseconds."},"p90":{"description":"The 90th percentile of the time taken to execute requests, in milliseconds."}},"required":["max","avg","p90"]},"cluster.stats__CCSUsageClusterStats":{"type":"object","properties":{"total":{"type":"number","description":"The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely."},"skipped":{"type":"number","description":"The total number of cross-cluster search requests for which this cluster was skipped."},"took":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageTimeValue","description":"Statistics about the time taken to execute requests against this cluster."}},"required":["total","skipped","took"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cluster.stats__StatsResponseBase":{"type":"object","properties":{"_nodes":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","description":"Contains statistics about the number of nodes selected by the request’s node filters.","x-codegen-name":"node_stats"},"cluster_name":{"type":"string","description":"Name of the cluster, based on the cluster name setting."},"cluster_uuid":{"type":"string","description":"Unique identifier for the cluster."},"indices":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterIndices","description":"Contains statistics about indices with shards assigned to selected nodes."},"nodes":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterNodes","description":"Contains statistics about nodes selected by the request’s node filters."},"repositories":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number"}},"description":"Contains stats on repository feature usage exposed in cluster stats for telemetry."},"snapshots":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterSnapshotStats","description":"Contains stats cluster snapshots."},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"Health status of the cluster, based on the state of its primary and replica shards."},"timestamp":{"type":"number","description":"Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed."},"ccs":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSStats","description":"Cross-cluster stats"}},"required":["cluster_name","cluster_uuid","indices","nodes","repositories","snapshots","timestamp","ccs"]},"cluster.stats__ClusterIndices":{"type":"object","properties":{"analysis":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CharFilterTypes","description":"Contains statistics about analyzers and analyzer components used in selected nodes."},"completion":{"$ref":"./_types.json#/$defs/_types__CompletionStats","description":"Contains statistics about memory used for completion in selected nodes."},"count":{"type":"number","description":"Total number of indices with shards assigned to selected nodes."},"docs":{"$ref":"./_types.json#/$defs/_types__DocStats","description":"Contains counts for documents in selected nodes."},"fielddata":{"$ref":"./_types.json#/$defs/_types__FielddataStats","description":"Contains statistics about the field data cache of selected nodes."},"query_cache":{"$ref":"./_types.json#/$defs/_types__QueryCacheStats","description":"Contains statistics about the query cache of selected nodes."},"search":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SearchUsageStats","description":"Holds a snapshot of the search usage statistics.\nUsed to hold the stats for a single node that's part of a ClusterStatsNodeResponse, as well as to\naccumulate stats for the entire cluster and return them as part of the ClusterStatsResponse."},"segments":{"$ref":"./_types.json#/$defs/_types__SegmentsStats","description":"Contains statistics about segments in selected nodes."},"shards":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterIndicesShards","description":"Contains statistics about indices with shards assigned to selected nodes."},"store":{"$ref":"./_types.json#/$defs/_types__StoreStats","description":"Contains statistics about the size of shards assigned to selected nodes."},"mappings":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypesMappings","description":"Contains statistics about field mappings in selected nodes."},"versions":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__IndicesVersions"},"description":"Contains statistics about analyzers and analyzer components used in selected nodes."},"dense_vector":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__DenseVectorStats","description":"Contains statistics about indexed dense vector"},"sparse_vector":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SparseVectorStats","description":"Contains statistics about indexed sparse vector"}},"required":["completion","count","docs","fielddata","query_cache","search","segments","shards","store","dense_vector","sparse_vector"]},"cluster.stats__CharFilterTypes":{"type":"object","properties":{"analyzer_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about analyzer types used in selected nodes."},"built_in_analyzers":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about built-in analyzers used in selected nodes."},"built_in_char_filters":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about built-in character filters used in selected nodes."},"built_in_filters":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about built-in token filters used in selected nodes."},"built_in_tokenizers":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about built-in tokenizers used in selected nodes."},"char_filter_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about character filter types used in selected nodes."},"multiple_synonym_graph_filters":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__MultipleSynonymGraphFilter"},"filter_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about token filter types used in selected nodes."},"tokenizer_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about tokenizer types used in selected nodes."},"synonyms":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SynonymsStats"},"description":"Contains statistics about synonyms types used in selected nodes."}},"required":["analyzer_types","built_in_analyzers","built_in_char_filters","built_in_filters","built_in_tokenizers","char_filter_types","filter_types","tokenizer_types","synonyms"]},"cluster.stats__FieldTypes":{"type":"object","properties":{"name":{"type":"string","description":"The name for the field type in selected nodes."},"count":{"type":"number","description":"The number of occurrences of the field type in selected nodes."},"index_count":{"type":"number","description":"The number of indices containing the field type in selected nodes."},"indexed_vector_count":{"type":"number","description":"For dense_vector field types, number of indexed vector types in selected nodes."},"indexed_vector_dim_max":{"type":"number","description":"For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes."},"indexed_vector_dim_min":{"type":"number","description":"For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes."},"script_count":{"type":"number","description":"The number of fields that declare a script.","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"vector_index_type_count":{"type":"object","additionalProperties":{"type":"number"},"description":"For dense_vector field types, count of mappings by index type"},"vector_similarity_type_count":{"type":"object","additionalProperties":{"type":"number"},"description":"For dense_vector field types, count of mappings by similarity"},"vector_element_type_count":{"type":"object","additionalProperties":{"type":"number"},"description":"For dense_vector field types, count of mappings by element type"}},"required":["name","count","index_count"]},"cluster.stats__MultipleSynonymGraphFilter":{"type":"object","properties":{"analyzer_count":{"type":"number","description":"Number of analyzers across the cluster whose filter chain contains more than one synonym_graph filter."},"index_count":{"type":"number","description":"Number of indices that contain at least one analyzer with more than one synonym_graph filter."}}},"cluster.stats__SynonymsStats":{"type":"object","properties":{"count":{"type":"number"},"index_count":{"type":"number"}},"required":["count","index_count"]},"cluster.stats__SearchUsageStats":{"type":"object","properties":{"total":{"type":"number"},"queries":{"type":"object","additionalProperties":{"type":"number"}},"rescorers":{"type":"object","additionalProperties":{"type":"number"}},"sections":{"type":"object","additionalProperties":{"type":"number"}},"retrievers":{"type":"object","additionalProperties":{"type":"number"}},"extended":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ExtendedSearchUsage"}},"required":["total","queries","rescorers","sections","retrievers","extended"]},"cluster.stats__ExtendedSearchUsage":{"type":"object","properties":{"retrievers":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ExtendedRetrieversSearchUsage"},"section":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ExtendedSectionSearchUsage"}}},"cluster.stats__ExtendedRetrieversSearchUsage":{"type":"object","properties":{"text_similarity_reranker":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ExtendedTextSimilarityRetrieverUsage"}}},"cluster.stats__ExtendedTextSimilarityRetrieverUsage":{"type":"object","properties":{"chunk_rescorer":{"type":"number"}}},"cluster.stats__ExtendedSectionSearchUsage":{"type":"object","properties":{"sort":{"type":"object","additionalProperties":{"type":"number"}}}},"cluster.stats__ClusterIndicesShards":{"type":"object","properties":{"index":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterIndicesShardsIndex","description":"Contains statistics about shards assigned to selected nodes."},"primaries":{"type":"number","description":"Number of primary shards assigned to selected nodes."},"replication":{"type":"number","description":"Ratio of replica shards to primary shards across all selected nodes."},"total":{"type":"number","description":"Total number of shards assigned to selected nodes."}},"description":"Contains statistics about shards assigned to selected nodes."},"cluster.stats__ClusterIndicesShardsIndex":{"type":"object","properties":{"primaries":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterShardMetrics","description":"Contains statistics about the number of primary shards assigned to selected nodes."},"replication":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterShardMetrics","description":"Contains statistics about the number of replication shards assigned to selected nodes."},"shards":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterShardMetrics","description":"Contains statistics about the number of shards assigned to selected nodes."}},"required":["primaries","replication","shards"]},"cluster.stats__ClusterShardMetrics":{"type":"object","properties":{"avg":{"type":"number","description":"Mean number of shards in an index, counting only shards assigned to selected nodes."},"max":{"type":"number","description":"Maximum number of shards in an index, counting only shards assigned to selected nodes."},"min":{"type":"number","description":"Minimum number of shards in an index, counting only shards assigned to selected nodes."}},"required":["avg","max","min"]},"cluster.stats__FieldTypesMappings":{"type":"object","properties":{"field_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__FieldTypes"},"description":"Contains statistics about field data types used in selected nodes."},"runtime_field_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__RuntimeFieldTypes"},"description":"Contains statistics about runtime field data types used in selected nodes."},"total_field_count":{"type":"number","description":"Total number of fields in all non-system indices."},"total_deduplicated_field_count":{"type":"number","description":"Total number of fields in all non-system indices, accounting for mapping deduplication."},"total_deduplicated_mapping_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total size of all mappings after deduplication and compression."},"total_deduplicated_mapping_size_in_bytes":{"type":"number","description":"Total size of all mappings, in bytes, after deduplication and compression."},"source_modes":{"type":"object","additionalProperties":{"type":"number"},"description":"Source mode usage count."}},"required":["field_types","runtime_field_types","source_modes"]},"cluster.stats__RuntimeFieldTypes":{"type":"object","properties":{"chars_max":{"type":"number","description":"Maximum number of characters for a single runtime field script."},"chars_total":{"type":"number","description":"Total number of characters for the scripts that define the current runtime field data type."},"count":{"type":"number","description":"Number of runtime fields mapped to the field data type in selected nodes."},"doc_max":{"type":"number","description":"Maximum number of accesses to doc_values for a single runtime field script"},"doc_total":{"type":"number","description":"Total number of accesses to doc_values for the scripts that define the current runtime field data type."},"index_count":{"type":"number","description":"Number of indices containing a mapping of the runtime field data type in selected nodes."},"lang":{"type":"array","items":{"type":"string"},"description":"Script languages used for the runtime fields scripts."},"lines_max":{"type":"number","description":"Maximum number of lines for a single runtime field script."},"lines_total":{"type":"number","description":"Total number of lines for the scripts that define the current runtime field data type."},"name":{"type":"string","description":"Field data type used in selected nodes."},"scriptless_count":{"type":"number","description":"Number of runtime fields that don’t declare a script."},"shadowed_count":{"type":"number","description":"Number of runtime fields that shadow an indexed field."},"source_max":{"type":"number","description":"Maximum number of accesses to _source for a single runtime field script."},"source_total":{"type":"number","description":"Total number of accesses to _source for the scripts that define the current runtime field data type."}},"required":["chars_max","chars_total","count","doc_max","doc_total","index_count","lang","lines_max","lines_total","name","scriptless_count","shadowed_count","source_max","source_total"]},"cluster.stats__IndicesVersions":{"type":"object","properties":{"index_count":{"type":"number"},"primary_shard_count":{"type":"number"},"total_primary_bytes":{"type":"number"},"total_primary_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"version":{"type":"string"}},"required":["index_count","primary_shard_count","total_primary_bytes","version"]},"cluster.stats__DenseVectorStats":{"type":"object","properties":{"value_count":{"type":"number"},"off_heap":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__DenseVectorOffHeapStats"}},"required":["value_count"]},"cluster.stats__DenseVectorOffHeapStats":{"type":"object","properties":{"total_size_bytes":{"type":"number"},"total_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_veb_size_bytes":{"type":"number"},"total_veb_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_vec_size_bytes":{"type":"number"},"total_vec_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_veq_size_bytes":{"type":"number"},"total_veq_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_vex_size_bytes":{"type":"number"},"total_vex_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_cenivf_size_bytes":{"type":"number"},"total_cenivf_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"total_clivf_size_bytes":{"type":"number"},"total_clivf_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"fielddata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number"}}}},"required":["total_size_bytes","total_veb_size_bytes","total_vec_size_bytes","total_veq_size_bytes","total_vex_size_bytes","total_cenivf_size_bytes","total_clivf_size_bytes"]},"cluster.stats__SparseVectorStats":{"type":"object","properties":{"value_count":{"type":"number"}},"required":["value_count"]},"cluster.stats__ClusterNodes":{"type":"object","properties":{"count":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterNodeCount","description":"Contains counts for nodes selected by the request’s node filters."},"discovery_types":{"type":"object","additionalProperties":{"type":"number"},"description":"Contains statistics about the discovery types used by selected nodes."},"fs":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterFileSystem","description":"Contains statistics about file stores by selected nodes."},"indexing_pressure":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__IndexingPressure","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}},"ingest":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterIngest"},"jvm":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterJvm","description":"Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes."},"network_types":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterNetworkTypes","description":"Contains statistics about the transport and HTTP networks used by selected nodes."},"os":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterOperatingSystem","description":"Contains statistics about the operating systems used by selected nodes."},"packaging_types":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__NodePackagingType"},"description":"Contains statistics about Elasticsearch distributions installed on selected nodes."},"plugins":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__PluginStats"},"description":"Contains statistics about installed plugins and modules by selected nodes.\nIf no plugins or modules are installed, this array is empty."},"process":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterProcess","description":"Contains statistics about processes used by selected nodes."},"versions":{"type":"array","items":{"type":"string"},"description":"Array of Elasticsearch versions used on selected nodes."}},"required":["count","discovery_types","fs","indexing_pressure","ingest","jvm","network_types","os","packaging_types","plugins","process","versions"]},"cluster.stats__ClusterNodeCount":{"type":"object","properties":{"total":{"type":"number"},"coordinating_only":{"type":"number"},"data":{"type":"number"},"data_cold":{"type":"number"},"data_content":{"type":"number"},"data_frozen":{"type":"number","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"data_hot":{"type":"number"},"data_warm":{"type":"number"},"index":{"type":"number"},"ingest":{"type":"number"},"master":{"type":"number"},"ml":{"type":"number"},"remote_cluster_client":{"type":"number"},"search":{"type":"number"},"transform":{"type":"number"},"voting_only":{"type":"number"}},"required":["total"]},"cluster.stats__ClusterFileSystem":{"type":"object","properties":{"path":{"type":"string"},"mount":{"type":"string"},"type":{"type":"string"},"available_in_bytes":{"type":"number","description":"Total number of bytes available to JVM in file stores across all selected nodes.\nDepending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.\nThis is the actual amount of free disk space the selected Elasticsearch nodes can use."},"available":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total number of bytes available to JVM in file stores across all selected nodes.\nDepending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.\nThis is the actual amount of free disk space the selected Elasticsearch nodes can use."},"free_in_bytes":{"type":"number","description":"Total number, in bytes, of unallocated bytes in file stores across all selected nodes."},"free":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total number of unallocated bytes in file stores across all selected nodes."},"total_in_bytes":{"type":"number","description":"Total size, in bytes, of all file stores across all selected nodes."},"total":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total size of all file stores across all selected nodes."},"low_watermark_free_space":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"low_watermark_free_space_in_bytes":{"type":"number"},"high_watermark_free_space":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"high_watermark_free_space_in_bytes":{"type":"number"},"flood_stage_free_space":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"flood_stage_free_space_in_bytes":{"type":"number"},"frozen_flood_stage_free_space":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"frozen_flood_stage_free_space_in_bytes":{"type":"number"}}},"cluster.stats__IndexingPressure":{"type":"object","properties":{"memory":{"$ref":"./nodes._types.json#/$defs/nodes._types__IndexingPressureMemory"}},"required":["memory"]},"cluster.stats__ClusterIngest":{"type":"object","properties":{"number_of_pipelines":{"type":"number"},"processor_stats":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterProcessor"}}},"required":["number_of_pipelines","processor_stats"]},"cluster.stats__ClusterProcessor":{"type":"object","properties":{"count":{"type":"number"},"current":{"type":"number"},"failed":{"type":"number"},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_millis":{}},"required":["count","current","failed","time_in_millis"]},"cluster.stats__ClusterJvm":{"type":"object","properties":{"max_uptime_in_millis":{"description":"Uptime duration, in milliseconds, since JVM last started."},"max_uptime":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Uptime duration since JVM last started."},"mem":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterJvmMemory","description":"Contains statistics about memory used by selected nodes."},"threads":{"type":"number","description":"Number of active threads in use by JVM across all selected nodes."},"versions":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterJvmVersion"},"description":"Contains statistics about the JVM versions used by selected nodes."}},"required":["max_uptime_in_millis","mem","threads","versions"]},"cluster.stats__ClusterJvmMemory":{"type":"object","properties":{"heap_max_in_bytes":{"type":"number","description":"Maximum amount of memory, in bytes, available for use by the heap across all selected nodes."},"heap_max":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Maximum amount of memory available for use by the heap across all selected nodes."},"heap_used_in_bytes":{"type":"number","description":"Memory, in bytes, currently in use by the heap across all selected nodes."},"heap_used":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Memory currently in use by the heap across all selected nodes."}},"required":["heap_max_in_bytes","heap_used_in_bytes"]},"cluster.stats__ClusterJvmVersion":{"type":"object","properties":{"bundled_jdk":{"type":"boolean","description":"Always `true`. All distributions come with a bundled Java Development Kit (JDK)."},"count":{"type":"number","description":"Total number of selected nodes using JVM."},"using_bundled_jdk":{"type":"boolean","description":"If `true`, a bundled JDK is in use by JVM."},"version":{"type":"string","description":"Version of JVM used by one or more selected nodes."},"vm_name":{"type":"string","description":"Name of the JVM."},"vm_vendor":{"type":"string","description":"Vendor of the JVM."},"vm_version":{"type":"string","description":"Full version number of JVM.\nThe full version number includes a plus sign (+) followed by the build number."}},"required":["bundled_jdk","count","using_bundled_jdk","version","vm_name","vm_vendor","vm_version"]},"cluster.stats__ClusterNetworkTypes":{"type":"object","properties":{"http_types":{"type":"object","additionalProperties":{"type":"number"},"description":"Contains statistics about the HTTP network types used by selected nodes."},"transport_types":{"type":"object","additionalProperties":{"type":"number"},"description":"Contains statistics about the transport network types used by selected nodes."}},"required":["http_types","transport_types"]},"cluster.stats__ClusterOperatingSystem":{"type":"object","properties":{"allocated_processors":{"type":"number","description":"Number of processors used to calculate thread pool size across all selected nodes.\nThis number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system.\nIn both cases, this number will never be larger than 32."},"architectures":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterOperatingSystemArchitecture"},"description":"Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes."},"available_processors":{"type":"number","description":"Number of processors available to JVM across all selected nodes."},"mem":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__OperatingSystemMemoryInfo","description":"Contains statistics about memory used by selected nodes."},"names":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterOperatingSystemName"},"description":"Contains statistics about operating systems used by selected nodes."},"pretty_names":{"type":"array","items":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterOperatingSystemPrettyName"},"description":"Contains statistics about operating systems used by selected nodes."}},"required":["allocated_processors","available_processors","mem","names","pretty_names"]},"cluster.stats__ClusterOperatingSystemArchitecture":{"type":"object","properties":{"arch":{"type":"string","description":"Name of an architecture used by one or more selected nodes."},"count":{"type":"number","description":"Number of selected nodes using the architecture."}},"required":["arch","count"]},"cluster.stats__OperatingSystemMemoryInfo":{"type":"object","properties":{"adjusted_total_in_bytes":{"type":"number","description":"Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set.","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}},"adjusted_total":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total amount of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set.","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}},"free_in_bytes":{"type":"number","description":"Amount, in bytes, of free physical memory across all selected nodes."},"free":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Amount of free physical memory across all selected nodes."},"free_percent":{"type":"number","description":"Percentage of free physical memory across all selected nodes."},"total_in_bytes":{"type":"number","description":"Total amount, in bytes, of physical memory across all selected nodes."},"total":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Total amount of physical memory across all selected nodes."},"used_in_bytes":{"type":"number","description":"Amount, in bytes, of physical memory in use across all selected nodes."},"used":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Amount of physical memory in use across all selected nodes."},"used_percent":{"type":"number","description":"Percentage of physical memory in use across all selected nodes."}},"required":["free_in_bytes","free_percent","total_in_bytes","used_in_bytes","used_percent"]},"cluster.stats__ClusterOperatingSystemName":{"type":"object","properties":{"count":{"type":"number","description":"Number of selected nodes using the operating system."},"name":{"type":"string","description":"Name of an operating system used by one or more selected nodes."}},"required":["count","name"]},"cluster.stats__ClusterOperatingSystemPrettyName":{"type":"object","properties":{"count":{"type":"number","description":"Number of selected nodes using the operating system."},"pretty_name":{"type":"string","description":"Human-readable name of an operating system used by one or more selected nodes."}},"required":["count","pretty_name"]},"cluster.stats__NodePackagingType":{"type":"object","properties":{"count":{"type":"number","description":"Number of selected nodes using the distribution flavor and file type."},"flavor":{"type":"string","description":"Type of Elasticsearch distribution. This is always `default`."},"type":{"type":"string","description":"File type (such as `tar` or `zip`) used for the distribution package."}},"required":["count","flavor","type"]},"cluster.stats__ClusterProcess":{"type":"object","properties":{"cpu":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterProcessCpu","description":"Contains statistics about CPU used by selected nodes."},"open_file_descriptors":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__ClusterProcessOpenFileDescriptors","description":"Contains statistics about open file descriptors in selected nodes."}},"required":["cpu","open_file_descriptors"]},"cluster.stats__ClusterProcessCpu":{"type":"object","properties":{"percent":{"type":"number","description":"Percentage of CPU used across all selected nodes.\nReturns `-1` if not supported."}},"required":["percent"]},"cluster.stats__ClusterProcessOpenFileDescriptors":{"type":"object","properties":{"avg":{"type":"number","description":"Average number of concurrently open file descriptors.\nReturns `-1` if not supported."},"max":{"type":"number","description":"Maximum number of concurrently open file descriptors allowed across all selected nodes.\nReturns `-1` if not supported."},"min":{"type":"number","description":"Minimum number of concurrently open file descriptors across all selected nodes.\nReturns -1 if not supported."}},"required":["avg","max","min"]},"cluster.stats__ClusterSnapshotStats":{"type":"object","properties":{"current_counts":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__SnapshotCurrentCounts"},"repositories":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__PerRepositoryStats"}}},"required":["current_counts","repositories"]},"cluster.stats__SnapshotCurrentCounts":{"type":"object","properties":{"snapshots":{"type":"number","description":"Snapshots currently in progress"},"shard_snapshots":{"type":"number","description":"Incomplete shard snapshots"},"snapshot_deletions":{"type":"number","description":"Snapshots deletions in progress"},"concurrent_operations":{"type":"number","description":"Sum of snapshots and snapshot_deletions"},"cleanups":{"type":"number","description":"Cleanups in progress, not counted in concurrent_operations as they are not concurrent"}},"required":["snapshots","shard_snapshots","snapshot_deletions","concurrent_operations","cleanups"]},"cluster.stats__PerRepositoryStats":{"type":"object","properties":{"type":{"type":"string"},"oldest_start_time_millis":{"$ref":"./_types.json#/$defs/_types__UnitMillis"},"oldest_start_time":{"type":"string"},"current_counts":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__RepositoryStatsCurrentCounts"}},"required":["type","oldest_start_time_millis","current_counts"]},"cluster.stats__RepositoryStatsCurrentCounts":{"type":"object","properties":{"snapshots":{"type":"number"},"clones":{"type":"number"},"finalizations":{"type":"number"},"deletions":{"type":"number"},"snapshot_deletions":{"type":"number"},"active_deletions":{"type":"number"},"shards":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__RepositoryStatsShards"}},"required":["snapshots","clones","finalizations","deletions","snapshot_deletions","active_deletions","shards"]},"cluster.stats__RepositoryStatsShards":{"type":"object","properties":{"total":{"type":"number"},"complete":{"type":"number"},"incomplete":{"type":"number"},"states":{"type":"object","additionalProperties":{"type":"number"}}},"required":["total","complete","incomplete","states"]},"cluster.stats__CCSStats":{"type":"object","properties":{"clusters":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__RemoteClusterInfo"},"description":"Contains remote cluster settings and metrics collected from them.\nThe keys are cluster names, and the values are per-cluster data.\nOnly present if `include_remotes` option is set to true."},"_search":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageStats","description":"Information about cross-cluster search usage."},"_esql":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageStats","description":"Information about ES|QL cross-cluster query usage."}},"required":["_search"]},"cluster.stats__RemoteClusterInfo":{"type":"object","properties":{"cluster_uuid":{"type":"string","description":"The UUID of the remote cluster."},"mode":{"type":"string","description":"The connection mode used to communicate with the remote cluster."},"skip_unavailable":{"type":"boolean","description":"The `skip_unavailable` setting used for this remote cluster."},"transport.compress":{"type":"string","description":"Transport compression setting used for this remote cluster."},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"Health status of the cluster, based on the state of its primary and replica shards."},"version":{"type":"array","items":{"type":"string"},"description":"The list of Elasticsearch versions used by the nodes on the remote cluster."},"nodes_count":{"type":"number","description":"The total count of nodes in the remote cluster."},"shards_count":{"type":"number","description":"The total number of shards in the remote cluster."},"indices_count":{"type":"number","description":"The total number of indices in the remote cluster."},"indices_total_size_in_bytes":{"type":"number","description":"Total data set size, in bytes, of all shards assigned to selected nodes."},"indices_total_size":{"type":"string","description":"Total data set size of all shards assigned to selected nodes, as a human-readable string."},"max_heap_in_bytes":{"type":"number","description":"Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster."},"max_heap":{"type":"string","description":"Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string."},"mem_total_in_bytes":{"type":"number","description":"Total amount, in bytes, of physical memory across the nodes of the remote cluster."},"mem_total":{"type":"string","description":"Total amount of physical memory across the nodes of the remote cluster, as a human-readable string."}},"required":["cluster_uuid","mode","skip_unavailable","transport.compress","status","version","nodes_count","shards_count","indices_count","indices_total_size_in_bytes","max_heap_in_bytes","mem_total_in_bytes"]},"cluster.stats__CCSUsageStats":{"type":"object","properties":{"total":{"type":"number","description":"The total number of cross-cluster search requests that have been executed by the cluster."},"success":{"type":"number","description":"The total number of cross-cluster search requests that have been successfully executed by the cluster."},"skipped":{"type":"number","description":"The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped."},"took":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageTimeValue","description":"Statistics about the time taken to execute cross-cluster search requests."},"took_mrt_true":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageTimeValue","description":"Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `true`."},"took_mrt_false":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageTimeValue","description":"Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `false`."},"remotes_per_search_max":{"type":"number","description":"The maximum number of remote clusters that were queried in a single cross-cluster search request."},"remotes_per_search_avg":{"type":"number","description":"The average number of remote clusters that were queried in a single cross-cluster search request."},"failure_reasons":{"type":"object","additionalProperties":{"type":"number"},"description":"Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason."},"features":{"type":"object","additionalProperties":{"type":"number"},"description":"The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both `async` and `wildcard`)."},"clients":{"type":"object","additionalProperties":{"type":"number"},"description":"Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as `kibana` or `elasticsearch`) are counted."},"clusters":{"type":"object","additionalProperties":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageClusterStats"},"description":"Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name `(local)`."}},"required":["total","success","skipped","took","remotes_per_search_max","remotes_per_search_avg","failure_reasons","features","clients","clusters"]},"cluster.stats__CCSUsageTimeValue":{"type":"object","properties":{"max":{"description":"The maximum time taken to execute a request, in milliseconds."},"avg":{"description":"The average time taken to execute a request, in milliseconds."},"p90":{"description":"The 90th percentile of the time taken to execute requests, in milliseconds."}},"required":["max","avg","p90"]},"cluster.stats__CCSUsageClusterStats":{"type":"object","properties":{"total":{"type":"number","description":"The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely."},"skipped":{"type":"number","description":"The total number of cross-cluster search requests for which this cluster was skipped."},"took":{"$ref":"./cluster.stats.json#/$defs/cluster.stats__CCSUsageTimeValue","description":"Statistics about the time taken to execute requests against this cluster."}},"required":["total","skipped","took"]}}}

package/src/es/json/cluster.stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.stats","description":"Get cluster statistics.\n\nGet basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).","x-api":{"id":"cluster.stats","name":"stats","namespace":"cluster"},"x-method":"GET","x-path":"/_cluster/stats","x-urls":[{"path":"/_cluster/stats","methods":["GET"]},{"path":"/_cluster/stats/nodes/{node_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"1.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"include_remotes":{"type":"boolean","description":"Include remote cluster data into the response","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its stats.\nHowever, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout.","x-found-in":"query"},"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.","x-found-in":"body"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cluster.stats","description":"Get cluster statistics.\n\nGet basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).","x-api":{"id":"cluster.stats","name":"stats","namespace":"cluster"},"x-method":"GET","x-path":"/_cluster/stats","x-urls":[{"path":"/_cluster/stats","methods":["GET"]},{"path":"/_cluster/stats/nodes/{node_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"1.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"include_remotes":{"type":"boolean","description":"Include remote cluster data into the response","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its stats.\nHowever, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout.","x-found-in":"query"},"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.","x-found-in":"body"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/connector._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"connector._types__Connector":{"type":"object","properties":{"api_key_id":{"type":"string"},"api_key_secret_id":{"type":"string"},"configuration":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorConfiguration"},"custom_scheduling":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorCustomScheduling"},"deleted":{"type":"boolean"},"description":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"features":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorFeatures"},"filtering":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringConfig"}},"id":{"type":"string"},"index_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_native":{"type":"boolean"},"language":{"type":"string"},"last_access_control_sync_error":{"type":"string"},"last_access_control_sync_scheduled_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"last_access_control_sync_status":{"$ref":"./connector._types.json#/$defs/connector._types__SyncStatus"},"last_deleted_document_count":{"type":"number"},"last_incremental_sync_scheduled_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"last_indexed_document_count":{"type":"number"},"last_seen":{"$ref":"./_types.json#/$defs/_types__DateTime"},"last_sync_error":{"type":"string"},"last_sync_scheduled_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"last_sync_status":{"$ref":"./connector._types.json#/$defs/connector._types__SyncStatus"},"last_synced":{"$ref":"./_types.json#/$defs/_types__DateTime"},"name":{"type":"string"},"pipeline":{"$ref":"./connector._types.json#/$defs/connector._types__IngestPipelineParams"},"scheduling":{"$ref":"./connector._types.json#/$defs/connector._types__SchedulingConfiguration"},"service_type":{"type":"string"},"status":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorStatus"},"sync_cursor":{},"sync_now":{"type":"boolean"}},"required":["configuration","custom_scheduling","deleted","filtering","is_native","scheduling","status","sync_now"]},"connector._types__ConnectorConfiguration":{"type":"object","additionalProperties":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorConfigProperties"}},"connector._types__ConnectorConfigProperties":{"type":"object","properties":{"category":{"type":"string"},"default_value":{"$ref":"./_types.json#/$defs/_types__ScalarValue"},"depends_on":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__Dependency"}},"display":{"$ref":"./connector._types.json#/$defs/connector._types__DisplayType"},"label":{"type":"string"},"options":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__SelectOption"}},"order":{"type":"number"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"sensitive":{"type":"boolean"},"tooltip":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorFieldType"},"ui_restrictions":{"type":"array","items":{"type":"string"}},"validations":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__Validation"}},"value":{}},"required":["default_value","depends_on","display","label","options","required","sensitive","value"]},"connector._types__Dependency":{"type":"object","properties":{"field":{"type":"string"},"value":{"$ref":"./_types.json#/$defs/_types__ScalarValue"}},"required":["field","value"]},"connector._types__DisplayType":{"enum":["textbox","textarea","numeric","toggle","dropdown"]},"connector._types__SelectOption":{"type":"object","properties":{"label":{"type":"string"},"value":{"$ref":"./_types.json#/$defs/_types__ScalarValue"}},"required":["label","value"]},"connector._types__ConnectorFieldType":{"enum":["str","int","list","bool"]},"connector._types__Validation":{"anyOf":[{"$ref":"./connector._types.json#/$defs/connector._types__LessThanValidation"},{"$ref":"./connector._types.json#/$defs/connector._types__GreaterThanValidation"},{"$ref":"./connector._types.json#/$defs/connector._types__ListTypeValidation"},{"$ref":"./connector._types.json#/$defs/connector._types__IncludedInValidation"},{"$ref":"./connector._types.json#/$defs/connector._types__RegexValidation"}]},"connector._types__LessThanValidation":{"type":"object","properties":{"type":{"const":"less_than"},"constraint":{"type":"number"}},"required":["type","constraint"]},"connector._types__GreaterThanValidation":{"type":"object","properties":{"type":{"const":"greater_than"},"constraint":{"type":"number"}},"required":["type","constraint"]},"connector._types__ListTypeValidation":{"type":"object","properties":{"type":{"const":"list_type"},"constraint":{"type":"string"}},"required":["type","constraint"]},"connector._types__IncludedInValidation":{"type":"object","properties":{"type":{"const":"included_in"},"constraint":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__ScalarValue"}}},"required":["type","constraint"]},"connector._types__RegexValidation":{"type":"object","properties":{"type":{"const":"regex"},"constraint":{"type":"string"}},"required":["type","constraint"]},"connector._types__ConnectorCustomScheduling":{"type":"object","additionalProperties":{"$ref":"./connector._types.json#/$defs/connector._types__CustomScheduling"}},"connector._types__CustomScheduling":{"type":"object","properties":{"configuration_overrides":{"$ref":"./connector._types.json#/$defs/connector._types__CustomSchedulingConfigurationOverrides"},"enabled":{"type":"boolean"},"interval":{"type":"string"},"last_synced":{"$ref":"./_types.json#/$defs/_types__DateTime"},"name":{"type":"string"}},"required":["configuration_overrides","enabled","interval","name"]},"connector._types__CustomSchedulingConfigurationOverrides":{"type":"object","properties":{"max_crawl_depth":{"type":"number"},"sitemap_discovery_disabled":{"type":"boolean"},"domain_allowlist":{"type":"array","items":{"type":"string"}},"sitemap_urls":{"type":"array","items":{"type":"string"}},"seed_urls":{"type":"array","items":{"type":"string"}}}},"connector._types__ConnectorFeatures":{"type":"object","properties":{"document_level_security":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether document-level security is enabled."},"incremental_sync":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether incremental syncs are enabled."},"native_connector_api_keys":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether managed connector API keys are enabled."},"sync_rules":{"$ref":"./connector._types.json#/$defs/connector._types__SyncRulesFeature"}}},"connector._types__FeatureEnabled":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"connector._types__SyncRulesFeature":{"type":"object","properties":{"advanced":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether advanced sync rules are enabled."},"basic":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether basic sync rules are enabled."}}},"connector._types__FilteringConfig":{"type":"object","properties":{"active":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRules"},"domain":{"type":"string"},"draft":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRules"}},"required":["active","draft"]},"connector._types__FilteringRules":{"type":"object","properties":{"advanced_snippet":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringAdvancedSnippet"},"rules":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRule"}},"validation":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRulesValidation"}},"required":["advanced_snippet","rules","validation"]},"connector._types__FilteringAdvancedSnippet":{"type":"object","properties":{"created_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"updated_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"value":{}},"required":["value"]},"connector._types__FilteringRule":{"type":"object","properties":{"created_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"id":{"type":"string"},"order":{"type":"number"},"policy":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringPolicy"},"rule":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRuleRule"},"updated_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"value":{"type":"string"}},"required":["field","id","order","policy","rule","value"]},"connector._types__FilteringPolicy":{"enum":["exclude","include"]},"connector._types__FilteringRuleRule":{"enum":["contains","ends_with","equals","regex","starts_with","greater_than","less_than"]},"connector._types__FilteringRulesValidation":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringValidation"}},"state":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringValidationState"}},"required":["errors","state"]},"connector._types__FilteringValidation":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"messages":{"type":"array","items":{"type":"string"}}},"required":["ids","messages"]},"connector._types__FilteringValidationState":{"enum":["edited","invalid","valid"]},"connector._types__SyncStatus":{"enum":["canceling","canceled","completed","error","in_progress","pending","suspended"]},"connector._types__IngestPipelineParams":{"type":"object","properties":{"extract_binary_content":{"type":"boolean"},"name":{"type":"string"},"reduce_whitespace":{"type":"boolean"},"run_ml_inference":{"type":"boolean"}},"required":["extract_binary_content","name","reduce_whitespace","run_ml_inference"]},"connector._types__SchedulingConfiguration":{"type":"object","properties":{"access_control":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorScheduling"},"full":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorScheduling"},"incremental":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorScheduling"}}},"connector._types__ConnectorScheduling":{"type":"object","properties":{"enabled":{"type":"boolean"},"interval":{"type":"string","description":"The interval is expressed using the crontab syntax"}},"required":["enabled","interval"]},"connector._types__ConnectorStatus":{"enum":["created","needs_configuration","configured","connected","error"]},"connector._types__ConnectorSyncJob":{"type":"object","properties":{"cancelation_requested_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"canceled_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"completed_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"connector":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobConnectorReference"},"created_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"deleted_document_count":{"type":"number"},"error":{"type":"string"},"id":{"type":"string"},"indexed_document_count":{"type":"number"},"indexed_document_volume":{"type":"number"},"job_type":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobType"},"last_seen":{"$ref":"./_types.json#/$defs/_types__DateTime"},"metadata":{"type":"object","additionalProperties":{}},"started_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"status":{"$ref":"./connector._types.json#/$defs/connector._types__SyncStatus"},"total_document_count":{"type":"number"},"trigger_method":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobTriggerMethod"},"worker_hostname":{"type":"string"}},"required":["connector","created_at","deleted_document_count","id","indexed_document_count","indexed_document_volume","job_type","metadata","status","total_document_count","trigger_method"]},"connector._types__SyncJobConnectorReference":{"type":"object","properties":{"configuration":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorConfiguration"},"filtering":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRules"},"id":{"type":"string"},"index_name":{"type":"string"},"language":{"type":"string"},"pipeline":{"$ref":"./connector._types.json#/$defs/connector._types__IngestPipelineParams"},"service_type":{"type":"string"},"sync_cursor":{}},"required":["configuration","filtering","id","index_name","service_type"]},"connector._types__SyncJobType":{"enum":["full","incremental","access_control"]},"connector._types__SyncJobTriggerMethod":{"enum":["on_demand","scheduled"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"connector._types__Connector":{"type":"object","properties":{"api_key_id":{"type":"string"},"api_key_secret_id":{"type":"string"},"configuration":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorConfiguration"},"custom_scheduling":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorCustomScheduling"},"deleted":{"type":"boolean"},"description":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"features":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorFeatures"},"filtering":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringConfig"}},"id":{"type":"string"},"index_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_native":{"type":"boolean"},"language":{"type":"string"},"last_access_control_sync_error":{"type":"string"},"last_access_control_sync_scheduled_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"last_access_control_sync_status":{"$ref":"./connector._types.json#/$defs/connector._types__SyncStatus"},"last_deleted_document_count":{"type":"number"},"last_incremental_sync_scheduled_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"last_indexed_document_count":{"type":"number"},"last_seen":{"$ref":"./_types.json#/$defs/_types__DateTime"},"last_sync_error":{"type":"string"},"last_sync_scheduled_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"last_sync_status":{"$ref":"./connector._types.json#/$defs/connector._types__SyncStatus"},"last_synced":{"$ref":"./_types.json#/$defs/_types__DateTime"},"name":{"type":"string"},"pipeline":{"$ref":"./connector._types.json#/$defs/connector._types__IngestPipelineParams"},"scheduling":{"$ref":"./connector._types.json#/$defs/connector._types__SchedulingConfiguration"},"service_type":{"type":"string"},"status":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorStatus"},"sync_cursor":{},"sync_now":{"type":"boolean"}},"required":["configuration","custom_scheduling","deleted","filtering","is_native","scheduling","status","sync_now"]},"connector._types__ConnectorConfiguration":{"type":"object","additionalProperties":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorConfigProperties"}},"connector._types__ConnectorConfigProperties":{"type":"object","properties":{"category":{"type":"string"},"default_value":{"$ref":"./_types.json#/$defs/_types__ScalarValue"},"depends_on":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__Dependency"}},"display":{"$ref":"./connector._types.json#/$defs/connector._types__DisplayType"},"label":{"type":"string"},"options":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__SelectOption"}},"order":{"type":"number"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"sensitive":{"type":"boolean"},"tooltip":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorFieldType"},"ui_restrictions":{"type":"array","items":{"type":"string"}},"validations":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__Validation"}},"value":{}},"required":["default_value","depends_on","display","label","options","required","sensitive","value"]},"connector._types__Dependency":{"type":"object","properties":{"field":{"type":"string"},"value":{"$ref":"./_types.json#/$defs/_types__ScalarValue"}},"required":["field","value"]},"connector._types__DisplayType":{"enum":["textbox","textarea","numeric","toggle","dropdown"]},"connector._types__SelectOption":{"type":"object","properties":{"label":{"type":"string"},"value":{"$ref":"./_types.json#/$defs/_types__ScalarValue"}},"required":["label","value"]},"connector._types__ConnectorFieldType":{"enum":["str","int","list","bool"]},"connector._types__Validation":{"anyOf":[{"$ref":"./connector._types.json#/$defs/connector._types__LessThanValidation"},{"$ref":"./connector._types.json#/$defs/connector._types__GreaterThanValidation"},{"$ref":"./connector._types.json#/$defs/connector._types__ListTypeValidation"},{"$ref":"./connector._types.json#/$defs/connector._types__IncludedInValidation"},{"$ref":"./connector._types.json#/$defs/connector._types__RegexValidation"}]},"connector._types__LessThanValidation":{"type":"object","properties":{"type":{"const":"less_than"},"constraint":{"type":"number"}},"required":["type","constraint"]},"connector._types__GreaterThanValidation":{"type":"object","properties":{"type":{"const":"greater_than"},"constraint":{"type":"number"}},"required":["type","constraint"]},"connector._types__ListTypeValidation":{"type":"object","properties":{"type":{"const":"list_type"},"constraint":{"type":"string"}},"required":["type","constraint"]},"connector._types__IncludedInValidation":{"type":"object","properties":{"type":{"const":"included_in"},"constraint":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__ScalarValue"}}},"required":["type","constraint"]},"connector._types__RegexValidation":{"type":"object","properties":{"type":{"const":"regex"},"constraint":{"type":"string"}},"required":["type","constraint"]},"connector._types__ConnectorCustomScheduling":{"type":"object","additionalProperties":{"$ref":"./connector._types.json#/$defs/connector._types__CustomScheduling"}},"connector._types__CustomScheduling":{"type":"object","properties":{"configuration_overrides":{"$ref":"./connector._types.json#/$defs/connector._types__CustomSchedulingConfigurationOverrides"},"enabled":{"type":"boolean"},"interval":{"type":"string"},"last_synced":{"$ref":"./_types.json#/$defs/_types__DateTime"},"name":{"type":"string"}},"required":["configuration_overrides","enabled","interval","name"]},"connector._types__CustomSchedulingConfigurationOverrides":{"type":"object","properties":{"max_crawl_depth":{"type":"number"},"sitemap_discovery_disabled":{"type":"boolean"},"domain_allowlist":{"type":"array","items":{"type":"string"}},"sitemap_urls":{"type":"array","items":{"type":"string"}},"seed_urls":{"type":"array","items":{"type":"string"}}}},"connector._types__ConnectorFeatures":{"type":"object","properties":{"document_level_security":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether document-level security is enabled."},"incremental_sync":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether incremental syncs are enabled."},"native_connector_api_keys":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether managed connector API keys are enabled."},"sync_rules":{"$ref":"./connector._types.json#/$defs/connector._types__SyncRulesFeature"}}},"connector._types__FeatureEnabled":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"connector._types__SyncRulesFeature":{"type":"object","properties":{"advanced":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether advanced sync rules are enabled."},"basic":{"$ref":"./connector._types.json#/$defs/connector._types__FeatureEnabled","description":"Indicates whether basic sync rules are enabled."}}},"connector._types__FilteringConfig":{"type":"object","properties":{"active":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRules"},"domain":{"type":"string"},"draft":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRules"}},"required":["active","draft"]},"connector._types__FilteringRules":{"type":"object","properties":{"advanced_snippet":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringAdvancedSnippet"},"rules":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRule"}},"validation":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRulesValidation"}},"required":["advanced_snippet","rules","validation"]},"connector._types__FilteringAdvancedSnippet":{"type":"object","properties":{"created_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"updated_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"value":{}},"required":["value"]},"connector._types__FilteringRule":{"type":"object","properties":{"created_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"id":{"type":"string"},"order":{"type":"number"},"policy":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringPolicy"},"rule":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRuleRule"},"updated_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"value":{"type":"string"}},"required":["field","id","order","policy","rule","value"]},"connector._types__FilteringPolicy":{"enum":["exclude","include"]},"connector._types__FilteringRuleRule":{"enum":["contains","ends_with","equals","regex","starts_with",">","<"],"x-codegen-names":{">":"greater_than","<":"less_than"}},"connector._types__FilteringRulesValidation":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringValidation"}},"state":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringValidationState"}},"required":["errors","state"]},"connector._types__FilteringValidation":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"messages":{"type":"array","items":{"type":"string"}}},"required":["ids","messages"]},"connector._types__FilteringValidationState":{"enum":["edited","invalid","valid"]},"connector._types__SyncStatus":{"enum":["canceling","canceled","completed","error","in_progress","pending","suspended"]},"connector._types__IngestPipelineParams":{"type":"object","properties":{"extract_binary_content":{"type":"boolean"},"name":{"type":"string"},"reduce_whitespace":{"type":"boolean"},"run_ml_inference":{"type":"boolean"}},"required":["extract_binary_content","name","reduce_whitespace","run_ml_inference"]},"connector._types__SchedulingConfiguration":{"type":"object","properties":{"access_control":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorScheduling"},"full":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorScheduling"},"incremental":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorScheduling"}}},"connector._types__ConnectorScheduling":{"type":"object","properties":{"enabled":{"type":"boolean"},"interval":{"type":"string","description":"The interval is expressed using the crontab syntax"}},"required":["enabled","interval"]},"connector._types__ConnectorStatus":{"enum":["created","needs_configuration","configured","connected","error"]},"connector._types__ConnectorSyncJob":{"type":"object","properties":{"cancelation_requested_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"canceled_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"completed_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"connector":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobConnectorReference"},"created_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"deleted_document_count":{"type":"number"},"error":{"type":"string"},"id":{"type":"string"},"indexed_document_count":{"type":"number"},"indexed_document_volume":{"type":"number"},"job_type":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobType"},"last_seen":{"$ref":"./_types.json#/$defs/_types__DateTime"},"metadata":{"type":"object","additionalProperties":{}},"started_at":{"$ref":"./_types.json#/$defs/_types__DateTime"},"status":{"$ref":"./connector._types.json#/$defs/connector._types__SyncStatus"},"total_document_count":{"type":"number"},"trigger_method":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobTriggerMethod"},"worker_hostname":{"type":"string"}},"required":["connector","created_at","deleted_document_count","id","indexed_document_count","indexed_document_volume","job_type","metadata","status","total_document_count","trigger_method"]},"connector._types__SyncJobConnectorReference":{"type":"object","properties":{"configuration":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorConfiguration"},"filtering":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRules"},"id":{"type":"string"},"index_name":{"type":"string"},"language":{"type":"string"},"pipeline":{"$ref":"./connector._types.json#/$defs/connector._types__IngestPipelineParams"},"service_type":{"type":"string"},"sync_cursor":{}},"required":["configuration","filtering","id","index_name","service_type"]},"connector._types__SyncJobType":{"enum":["full","incremental","access_control"]},"connector._types__SyncJobTriggerMethod":{"enum":["on_demand","scheduled"]}}}

package/src/es/json/connector.check_in.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.check_in","description":"Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.","x-api":{"id":"connector.check_in","name":"check-in","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_check_in","x-urls":[{"path":"/_connector/{connector_id}/_check_in","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"connector_id":{"type":"string","description":"The unique identifier of the connector to be checked in","x-found-in":"path"}},"required":["connector_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.check_in","description":"Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.","x-api":{"id":"connector.check_in","name":"check-in","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_check_in","x-urls":[{"path":"/_connector/{connector_id}/_check_in","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"connector_id":{"type":"string","description":"The unique identifier of the connector to be checked in","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_id"]}

package/src/es/json/connector.delete.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.delete","description":"Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.","x-api":{"id":"connector.delete","name":"delete","namespace":"connector"},"x-method":"DELETE","x-path":"/_connector/{connector_id}","x-urls":[{"path":"/_connector/{connector_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"delete_sync_jobs":{"type":"boolean","description":"A flag indicating if associated sync jobs should be also removed.","x-found-in":"query"},"hard":{"type":"boolean","description":"A flag indicating if the connector should be hard deleted.","x-found-in":"query"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be deleted","x-found-in":"path"}},"required":["connector_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.delete","description":"Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.","x-api":{"id":"connector.delete","name":"delete","namespace":"connector"},"x-method":"DELETE","x-path":"/_connector/{connector_id}","x-urls":[{"path":"/_connector/{connector_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"delete_sync_jobs":{"type":"boolean","description":"A flag indicating if associated sync jobs should be also removed.","x-found-in":"query"},"hard":{"type":"boolean","description":"A flag indicating if the connector should be hard deleted.","x-found-in":"query"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be deleted","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_id"]}

package/src/es/json/connector.get.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.get","description":"Get a connector.\n\nGet the details about a connector.","x-api":{"id":"connector.get","name":"get","namespace":"connector"},"x-method":"GET","x-path":"/_connector/{connector_id}","x-urls":[{"path":"/_connector/{connector_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"include_deleted":{"type":"boolean","description":"A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.","x-found-in":"query"},"connector_id":{"type":"string","description":"The unique identifier of the connector","x-found-in":"path"}},"required":["connector_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.get","description":"Get a connector.\n\nGet the details about a connector.","x-api":{"id":"connector.get","name":"get","namespace":"connector"},"x-method":"GET","x-path":"/_connector/{connector_id}","x-urls":[{"path":"/_connector/{connector_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"include_deleted":{"type":"boolean","description":"A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.","x-found-in":"query"},"connector_id":{"type":"string","description":"The unique identifier of the connector","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_id"]}

package/src/es/json/connector.list.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.list","description":"Get all connectors.\n\nGet information about all connectors.","x-api":{"id":"connector.list","name":"list","namespace":"connector"},"x-method":"GET","x-path":"/_connector","x-urls":[{"path":"/_connector","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"Starting offset","x-found-in":"query"},"size":{"type":"number","description":"Specifies a max number of results to get","x-found-in":"query"},"index_name":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of connector index names to fetch connector documents for","x-found-in":"query"},"connector_name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of connector names to fetch connector documents for","x-found-in":"query"},"service_type":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of connector service types to fetch connector documents for","x-found-in":"query"},"include_deleted":{"type":"boolean","description":"A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.","x-found-in":"query"},"query":{"type":"string","description":"A wildcard query string that filters connectors with matching name, description or index name","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.list","description":"Get all connectors.\n\nGet information about all connectors.","x-api":{"id":"connector.list","name":"list","namespace":"connector"},"x-method":"GET","x-path":"/_connector","x-urls":[{"path":"/_connector","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"Starting offset","x-found-in":"query"},"size":{"type":"number","description":"Specifies a max number of results to get","x-found-in":"query"},"index_name":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of connector index names to fetch connector documents for","x-found-in":"query"},"connector_name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of connector names to fetch connector documents for","x-found-in":"query"},"service_type":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of connector service types to fetch connector documents for","x-found-in":"query"},"include_deleted":{"type":"boolean","description":"A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.","x-found-in":"query"},"query":{"type":"string","description":"A wildcard query string that filters connectors with matching name, description or index name","x-found-in":"query"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/connector.post.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.post","description":"Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.","x-api":{"id":"connector.post","name":"post","namespace":"connector"},"x-method":"POST","x-path":"/_connector","x-urls":[{"path":"/_connector","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"description":{"type":"string","x-found-in":"body"},"index_name":{"type":"string","x-found-in":"body"},"is_native":{"type":"boolean","x-found-in":"body"},"language":{"type":"string","x-found-in":"body"},"name":{"type":"string","x-found-in":"body"},"service_type":{"type":"string","x-found-in":"body"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.post","description":"Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.","x-api":{"id":"connector.post","name":"post","namespace":"connector"},"x-method":"POST","x-path":"/_connector","x-urls":[{"path":"/_connector","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"description":{"type":"string","x-found-in":"body"},"index_name":{"type":"string","x-found-in":"body"},"is_native":{"type":"boolean","x-found-in":"body"},"language":{"type":"string","x-found-in":"body"},"name":{"type":"string","x-found-in":"body"},"service_type":{"type":"string","x-found-in":"body"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/connector.put.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.put","description":"Create or update a connector.","x-api":{"id":"connector.put","name":"put","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}","x-urls":[{"path":"/_connector/{connector_id}","methods":["PUT"]},{"path":"/_connector","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"description":{"type":"string","x-found-in":"body"},"index_name":{"type":"string","x-found-in":"body"},"is_native":{"type":"boolean","x-found-in":"body"},"language":{"type":"string","x-found-in":"body"},"name":{"type":"string","x-found-in":"body"},"service_type":{"type":"string","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.put","description":"Create or update a connector.","x-api":{"id":"connector.put","name":"put","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}","x-urls":[{"path":"/_connector/{connector_id}","methods":["PUT"]},{"path":"/_connector","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"description":{"type":"string","x-found-in":"body"},"index_name":{"type":"string","x-found-in":"body"},"is_native":{"type":"boolean","x-found-in":"body"},"language":{"type":"string","x-found-in":"body"},"name":{"type":"string","x-found-in":"body"},"service_type":{"type":"string","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/connector.sync_job_cancel.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_cancel","description":"Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.","x-api":{"id":"connector.sync_job_cancel","name":"sync-job-cancel","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_cancel","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_cancel","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job","x-found-in":"path"}},"required":["connector_sync_job_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_cancel","description":"Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.","x-api":{"id":"connector.sync_job_cancel","name":"sync-job-cancel","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_cancel","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_cancel","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_sync_job_id"]}

package/src/es/json/connector.sync_job_check_in.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_check_in","description":"Check in a connector sync job.\n\nCheck in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.sync_job_check_in","name":"sync-job-check-in","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_check_in","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_check_in","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job to be checked in.","x-found-in":"path"}},"required":["connector_sync_job_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_check_in","description":"Check in a connector sync job.\n\nCheck in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.sync_job_check_in","name":"sync-job-check-in","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_check_in","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_check_in","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job to be checked in.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_sync_job_id"]}

package/src/es/json/connector.sync_job_claim.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_claim","description":"Claim a connector sync job.\n\nThis action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time.\nAdditionally, it can set the `sync_cursor` property for the sync job.\n\nThis API is not intended for direct connector management by users.\nIt supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.sync_job_claim","name":"sync-job-claim","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_claim","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_claim","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"sync_cursor":{"description":"The cursor object from the last incremental sync job.\nThis should reference the `sync_cursor` field in the connector state for which the job runs.","x-found-in":"body"},"worker_hostname":{"type":"string","description":"The host name of the current system that will run the job.","x-found-in":"body"},"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job.","x-found-in":"path"}},"required":["connector_sync_job_id","worker_hostname"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_claim","description":"Claim a connector sync job.\n\nThis action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time.\nAdditionally, it can set the `sync_cursor` property for the sync job.\n\nThis API is not intended for direct connector management by users.\nIt supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.sync_job_claim","name":"sync-job-claim","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_claim","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_claim","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"sync_cursor":{"description":"The cursor object from the last incremental sync job.\nThis should reference the `sync_cursor` field in the connector state for which the job runs.","x-found-in":"body"},"worker_hostname":{"type":"string","description":"The host name of the current system that will run the job.","x-found-in":"body"},"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_sync_job_id","worker_hostname"]}

package/src/es/json/connector.sync_job_delete.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_delete","description":"Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.","x-api":{"id":"connector.sync_job_delete","name":"sync-job-delete","namespace":"connector"},"x-method":"DELETE","x-path":"/_connector/_sync_job/{connector_sync_job_id}","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job to be deleted","x-found-in":"path"}},"required":["connector_sync_job_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_delete","description":"Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.","x-api":{"id":"connector.sync_job_delete","name":"sync-job-delete","namespace":"connector"},"x-method":"DELETE","x-path":"/_connector/_sync_job/{connector_sync_job_id}","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job to be deleted","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_sync_job_id"]}

package/src/es/json/connector.sync_job_error.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_error","description":"Set a connector sync job error.\n\nSet the `error` field for a connector sync job and set its `status` to `error`.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.sync_job_error","name":"sync-job-error","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_error","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_error","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"error":{"type":"string","description":"The error for the connector sync job error field.","x-found-in":"body"},"connector_sync_job_id":{"type":"string","description":"The unique identifier for the connector sync job.","x-found-in":"path"}},"required":["connector_sync_job_id","error"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_error","description":"Set a connector sync job error.\n\nSet the `error` field for a connector sync job and set its `status` to `error`.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.sync_job_error","name":"sync-job-error","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_error","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_error","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"error":{"type":"string","description":"The error for the connector sync job error field.","x-found-in":"body"},"connector_sync_job_id":{"type":"string","description":"The unique identifier for the connector sync job.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_sync_job_id","error"]}

package/src/es/json/connector.sync_job_get.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_get","description":"Get a connector sync job.","x-api":{"id":"connector.sync_job_get","name":"sync-job-get","namespace":"connector"},"x-method":"GET","x-path":"/_connector/_sync_job/{connector_sync_job_id}","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job","x-found-in":"path"}},"required":["connector_sync_job_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_get","description":"Get a connector sync job.","x-api":{"id":"connector.sync_job_get","name":"sync-job-get","namespace":"connector"},"x-method":"GET","x-path":"/_connector/_sync_job/{connector_sync_job_id}","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["connector_sync_job_id"]}

package/src/es/json/connector.sync_job_list.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_list","description":"Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.","x-api":{"id":"connector.sync_job_list","name":"sync-job-list","namespace":"connector"},"x-method":"GET","x-path":"/_connector/_sync_job","x-urls":[{"path":"/_connector/_sync_job","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"Starting offset","x-found-in":"query"},"size":{"type":"number","description":"Specifies a max number of results to get","x-found-in":"query"},"status":{"$ref":"./connector._types.json#/$defs/connector._types__SyncStatus","description":"A sync job status to fetch connector sync jobs for","x-found-in":"query"},"connector_id":{"type":"string","description":"A connector id to fetch connector sync jobs for","x-found-in":"query"},"job_type":{"anyOf":[{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobType"},{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobType"}}],"description":"A comma-separated list of job types to fetch the sync jobs for","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_list","description":"Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.","x-api":{"id":"connector.sync_job_list","name":"sync-job-list","namespace":"connector"},"x-method":"GET","x-path":"/_connector/_sync_job","x-urls":[{"path":"/_connector/_sync_job","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"Starting offset","x-found-in":"query"},"size":{"type":"number","description":"Specifies a max number of results to get","x-found-in":"query"},"status":{"$ref":"./connector._types.json#/$defs/connector._types__SyncStatus","description":"A sync job status to fetch connector sync jobs for","x-found-in":"query"},"connector_id":{"type":"string","description":"A connector id to fetch connector sync jobs for","x-found-in":"query"},"job_type":{"anyOf":[{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobType"},{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobType"}}],"description":"A comma-separated list of job types to fetch the sync jobs for","x-found-in":"query"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_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.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}