From f5b8d32c15ab2a6dcc6bfb74f3a9568c156f57dd Mon Sep 17 00:00:00 2001 From: delvedor Date: Mon, 28 Sep 2020 10:22:52 +0200 Subject: [PATCH] API generation --- api/api/ml.js | 4 +- api/requestParams.d.ts | 1 + docs/reference.asciidoc | 346 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 349 insertions(+), 2 deletions(-) diff --git a/api/api/ml.js b/api/api/ml.js index 1943cb0a7..6a220a8d6 100644 --- a/api/api/ml.js +++ b/api/api/ml.js @@ -23,8 +23,8 @@ /* eslint no-unused-vars: 0 */ const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils') -const acceptedQuerystring = ['allow_no_match', 'allow_no_jobs', 'force', 'timeout', 'pretty', 'human', 'error_trace', 'source', 'filter_path', 'requests_per_second', 'allow_no_forecasts', 'wait_for_completion', 'lines_to_sample', 'line_merge_size_limit', 'charset', 'format', 'has_header_row', 'column_names', 'delimiter', 'quote', 'should_trim_fields', 'grok_pattern', 'timestamp_field', 'timestamp_format', 'explain', 'calc_interim', 'start', 'end', 'advance_time', 'skip_time', 'duration', 'expires_in', 'max_model_memory', 'expand', 'exclude_interim', 'from', 'size', 'anomaly_score', 'sort', 'desc', 'job_id', 'partition_field_value', 'verbose', 'allow_no_datafeeds', 'influencer_score', 'top_n', 'bucket_span', 'overall_score', 'record_score', 'include', 'decompress_definition', 'tags', 'for_export', 'reset_start', 'reset_end', 'ignore_unavailable', 'allow_no_indices', 'ignore_throttled', 'expand_wildcards', 'delete_intervening_results', 'enabled'] -const snakeCase = { allowNoMatch: 'allow_no_match', allowNoJobs: 'allow_no_jobs', errorTrace: 'error_trace', filterPath: 'filter_path', requestsPerSecond: 'requests_per_second', allowNoForecasts: 'allow_no_forecasts', waitForCompletion: 'wait_for_completion', linesToSample: 'lines_to_sample', lineMergeSizeLimit: 'line_merge_size_limit', hasHeaderRow: 'has_header_row', columnNames: 'column_names', shouldTrimFields: 'should_trim_fields', grokPattern: 'grok_pattern', timestampField: 'timestamp_field', timestampFormat: 'timestamp_format', calcInterim: 'calc_interim', advanceTime: 'advance_time', skipTime: 'skip_time', expiresIn: 'expires_in', maxModelMemory: 'max_model_memory', excludeInterim: 'exclude_interim', anomalyScore: 'anomaly_score', jobId: 'job_id', partitionFieldValue: 'partition_field_value', allowNoDatafeeds: 'allow_no_datafeeds', influencerScore: 'influencer_score', topN: 'top_n', bucketSpan: 'bucket_span', overallScore: 'overall_score', recordScore: 'record_score', decompressDefinition: 'decompress_definition', forExport: 'for_export', resetStart: 'reset_start', resetEnd: 'reset_end', ignoreUnavailable: 'ignore_unavailable', allowNoIndices: 'allow_no_indices', ignoreThrottled: 'ignore_throttled', expandWildcards: 'expand_wildcards', deleteInterveningResults: 'delete_intervening_results' } +const acceptedQuerystring = ['allow_no_match', 'allow_no_jobs', 'force', 'timeout', 'pretty', 'human', 'error_trace', 'source', 'filter_path', 'requests_per_second', 'allow_no_forecasts', 'wait_for_completion', 'lines_to_sample', 'line_merge_size_limit', 'charset', 'format', 'has_header_row', 'column_names', 'delimiter', 'quote', 'should_trim_fields', 'grok_pattern', 'timestamp_field', 'timestamp_format', 'explain', 'calc_interim', 'start', 'end', 'advance_time', 'skip_time', 'duration', 'expires_in', 'max_model_memory', 'expand', 'exclude_interim', 'from', 'size', 'anomaly_score', 'sort', 'desc', 'job_id', 'partition_field_value', 'verbose', 'allow_no_datafeeds', 'influencer_score', 'top_n', 'bucket_span', 'overall_score', 'record_score', 'include', 'include_model_definition', 'decompress_definition', 'tags', 'for_export', 'reset_start', 'reset_end', 'ignore_unavailable', 'allow_no_indices', 'ignore_throttled', 'expand_wildcards', 'delete_intervening_results', 'enabled'] +const snakeCase = { allowNoMatch: 'allow_no_match', allowNoJobs: 'allow_no_jobs', errorTrace: 'error_trace', filterPath: 'filter_path', requestsPerSecond: 'requests_per_second', allowNoForecasts: 'allow_no_forecasts', waitForCompletion: 'wait_for_completion', linesToSample: 'lines_to_sample', lineMergeSizeLimit: 'line_merge_size_limit', hasHeaderRow: 'has_header_row', columnNames: 'column_names', shouldTrimFields: 'should_trim_fields', grokPattern: 'grok_pattern', timestampField: 'timestamp_field', timestampFormat: 'timestamp_format', calcInterim: 'calc_interim', advanceTime: 'advance_time', skipTime: 'skip_time', expiresIn: 'expires_in', maxModelMemory: 'max_model_memory', excludeInterim: 'exclude_interim', anomalyScore: 'anomaly_score', jobId: 'job_id', partitionFieldValue: 'partition_field_value', allowNoDatafeeds: 'allow_no_datafeeds', influencerScore: 'influencer_score', topN: 'top_n', bucketSpan: 'bucket_span', overallScore: 'overall_score', recordScore: 'record_score', includeModelDefinition: 'include_model_definition', decompressDefinition: 'decompress_definition', forExport: 'for_export', resetStart: 'reset_start', resetEnd: 'reset_end', ignoreUnavailable: 'ignore_unavailable', allowNoIndices: 'allow_no_indices', ignoreThrottled: 'ignore_throttled', expandWildcards: 'expand_wildcards', deleteInterveningResults: 'delete_intervening_results' } function MlApi (transport, ConfigurationError) { this.transport = transport diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index 9c4c4b5b8..ff63e825c 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -1689,6 +1689,7 @@ export interface MlGetTrainedModels extends Generic { model_id?: string; allow_no_match?: boolean; include?: string; + include_model_definition?: boolean; decompress_definition?: boolean; from?: number; size?: number; diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index dfde27052..be198acdc 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -72,6 +72,7 @@ In this document, you will find the reference of every parameter accepted by the +[discrete] === Common parameters Parameters that are accepted by all API endpoints. @@ -95,6 +96,7 @@ link:{ref}/common-options.html[Documentation] |`list` - A comma-separated list of filters used to reduce the response. |=== +[discrete] === asyncSearch.delete [source,ts] @@ -111,6 +113,7 @@ link:{ref}/async-search.html[Documentation] + |=== +[discrete] === asyncSearch.get [source,ts] @@ -139,6 +142,7 @@ link:{ref}/async-search.html[Documentation] + |=== +[discrete] === asyncSearch.submit [source,ts] @@ -331,6 +335,7 @@ _Default:_ `5` |=== +[discrete] === autoscaling.deleteAutoscalingPolicy *Stability:* experimental [source,ts] @@ -347,6 +352,7 @@ link:{ref}/autoscaling-delete-autoscaling-policy.html[Documentation] + |=== +[discrete] === autoscaling.getAutoscalingDecision *Stability:* experimental [source,ts] @@ -356,6 +362,7 @@ client.autoscaling.getAutoscalingDecision() link:{ref}/autoscaling-get-autoscaling-decision.html[Documentation] + +[discrete] === autoscaling.getAutoscalingPolicy *Stability:* experimental [source,ts] @@ -372,6 +379,7 @@ link:{ref}/autoscaling-get-autoscaling-policy.html[Documentation] + |=== +[discrete] === autoscaling.putAutoscalingPolicy *Stability:* experimental [source,ts] @@ -392,6 +400,7 @@ link:{ref}/autoscaling-put-autoscaling-policy.html[Documentation] + |=== +[discrete] === bulk [source,ts] @@ -453,6 +462,7 @@ link:{ref}/docs-bulk.html[Documentation] + |=== +[discrete] === cat.aliases [source,ts] @@ -498,6 +508,7 @@ _Default:_ `all` |=== +[discrete] === cat.allocation [source,ts] @@ -546,6 +557,7 @@ link:{ref}/cat-allocation.html[Documentation] + |=== +[discrete] === cat.count [source,ts] @@ -582,6 +594,7 @@ link:{ref}/cat-count.html[Documentation] + |=== +[discrete] === cat.fielddata [source,ts] @@ -622,6 +635,7 @@ link:{ref}/cat-fielddata.html[Documentation] + |=== +[discrete] === cat.health [source,ts] @@ -663,6 +677,7 @@ _Default:_ `true` |=== +[discrete] === cat.help [source,ts] @@ -683,6 +698,7 @@ link:{ref}/cat.html[Documentation] + |=== +[discrete] === cat.indices [source,ts] @@ -752,6 +768,7 @@ _Default:_ `all` |=== +[discrete] === cat.master [source,ts] @@ -792,6 +809,7 @@ link:{ref}/cat-master.html[Documentation] + |=== +[discrete] === cat.mlDataFrameAnalytics [source,ts] @@ -840,6 +858,7 @@ link:{ref}/cat-dfanalytics.html[Documentation] + |=== +[discrete] === cat.mlDatafeeds [source,ts] @@ -890,6 +909,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === cat.mlJobs [source,ts] @@ -944,6 +964,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === cat.mlTrainedModels [source,ts] @@ -1002,6 +1023,7 @@ _Default:_ `100` |=== +[discrete] === cat.nodeattrs [source,ts] @@ -1042,6 +1064,7 @@ link:{ref}/cat-nodeattrs.html[Documentation] + |=== +[discrete] === cat.nodes [source,ts] @@ -1096,6 +1119,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === cat.pendingTasks [source,ts] @@ -1140,6 +1164,7 @@ link:{ref}/cat-pending-tasks.html[Documentation] + |=== +[discrete] === cat.plugins [source,ts] @@ -1180,6 +1205,7 @@ link:{ref}/cat-plugins.html[Documentation] + |=== +[discrete] === cat.recovery [source,ts] @@ -1232,6 +1258,7 @@ link:{ref}/cat-recovery.html[Documentation] + |=== +[discrete] === cat.repositories [source,ts] @@ -1272,6 +1299,7 @@ link:{ref}/cat-repositories.html[Documentation] + |=== +[discrete] === cat.segments [source,ts] @@ -1312,6 +1340,7 @@ link:{ref}/cat-segments.html[Documentation] + |=== +[discrete] === cat.shards [source,ts] @@ -1364,6 +1393,7 @@ link:{ref}/cat-shards.html[Documentation] + |=== +[discrete] === cat.snapshots [source,ts] @@ -1412,6 +1442,7 @@ link:{ref}/cat-snapshots.html[Documentation] + |=== +[discrete] === cat.tasks [source,ts] @@ -1464,6 +1495,7 @@ link:{ref}/tasks.html[Documentation] + |=== +[discrete] === cat.templates [source,ts] @@ -1508,6 +1540,7 @@ link:{ref}/cat-templates.html[Documentation] + |=== +[discrete] === cat.threadPool [source,ts] @@ -1558,6 +1591,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === cat.transforms [source,ts] @@ -1610,6 +1644,7 @@ link:{ref}/cat-transforms.html[Documentation] + |=== +[discrete] === ccr.deleteAutoFollowPattern [source,ts] @@ -1626,6 +1661,7 @@ link:{ref}/ccr-delete-auto-follow-pattern.html[Documentation] + |=== +[discrete] === ccr.follow [source,ts] @@ -1651,6 +1687,7 @@ _Default:_ `0` |=== +[discrete] === ccr.followInfo [source,ts] @@ -1667,6 +1704,7 @@ link:{ref}/ccr-get-follow-info.html[Documentation] + |=== +[discrete] === ccr.followStats [source,ts] @@ -1683,6 +1721,7 @@ link:{ref}/ccr-get-follow-stats.html[Documentation] + |=== +[discrete] === ccr.forgetFollower [source,ts] @@ -1703,6 +1742,7 @@ link:{ref}/ccr-post-forget-follower.html[Documentation] + |=== +[discrete] === ccr.getAutoFollowPattern [source,ts] @@ -1719,6 +1759,7 @@ link:{ref}/ccr-get-auto-follow-pattern.html[Documentation] + |=== +[discrete] === ccr.pauseAutoFollowPattern [source,ts] @@ -1735,6 +1776,7 @@ link:{ref}/ccr-pause-auto-follow-pattern.html[Documentation] + |=== +[discrete] === ccr.pauseFollow [source,ts] @@ -1751,6 +1793,7 @@ link:{ref}/ccr-post-pause-follow.html[Documentation] + |=== +[discrete] === ccr.putAutoFollowPattern [source,ts] @@ -1771,6 +1814,7 @@ link:{ref}/ccr-put-auto-follow-pattern.html[Documentation] + |=== +[discrete] === ccr.resumeAutoFollowPattern [source,ts] @@ -1787,6 +1831,7 @@ link:{ref}/ccr-resume-auto-follow-pattern.html[Documentation] + |=== +[discrete] === ccr.resumeFollow [source,ts] @@ -1807,6 +1852,7 @@ link:{ref}/ccr-post-resume-follow.html[Documentation] + |=== +[discrete] === ccr.stats [source,ts] @@ -1816,6 +1862,7 @@ client.ccr.stats() link:{ref}/ccr-get-stats.html[Documentation] + +[discrete] === ccr.unfollow [source,ts] @@ -1832,6 +1879,7 @@ link:{ref}/ccr-post-unfollow.html[Documentation] + |=== +[discrete] === clearScroll [source,ts] @@ -1854,6 +1902,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === closePointInTime [source,ts] @@ -1870,6 +1919,7 @@ link:{ref}/point-in-time-api.html[Documentation] + |=== +[discrete] === cluster.allocationExplain [source,ts] @@ -1894,6 +1944,7 @@ link:{ref}/cluster-allocation-explain.html[Documentation] + |=== +[discrete] === cluster.deleteComponentTemplate *Stability:* experimental [source,ts] @@ -1918,6 +1969,7 @@ link:{ref}/indices-component-template.html[Documentation] + |=== +[discrete] === cluster.deleteVotingConfigExclusions [source,ts] @@ -1935,6 +1987,7 @@ _Default:_ `true` |=== +[discrete] === cluster.existsComponentTemplate *Stability:* experimental [source,ts] @@ -1959,6 +2012,7 @@ link:{ref}/indices-component-template.html[Documentation] + |=== +[discrete] === cluster.getComponentTemplate *Stability:* experimental [source,ts] @@ -1983,6 +2037,7 @@ link:{ref}/indices-component-template.html[Documentation] + |=== +[discrete] === cluster.getSettings [source,ts] @@ -2011,6 +2066,7 @@ link:{ref}/cluster-update-settings.html[Documentation] + |=== +[discrete] === cluster.health [source,ts] @@ -2073,6 +2129,7 @@ _Default:_ `cluster` |=== +[discrete] === cluster.pendingTasks [source,ts] @@ -2093,6 +2150,7 @@ link:{ref}/cluster-pending.html[Documentation] + |=== +[discrete] === cluster.postVotingConfigExclusions [source,ts] @@ -2118,6 +2176,7 @@ _Default:_ `30s` |=== +[discrete] === cluster.putComponentTemplate *Stability:* experimental [source,ts] @@ -2150,6 +2209,7 @@ link:{ref}/indices-component-template.html[Documentation] + |=== +[discrete] === cluster.putSettings [source,ts] @@ -2178,6 +2238,7 @@ link:{ref}/cluster-update-settings.html[Documentation] + |=== +[discrete] === cluster.remoteInfo [source,ts] @@ -2187,6 +2248,7 @@ client.cluster.remoteInfo() link:{ref}/cluster-remote-info.html[Documentation] + +[discrete] === cluster.reroute [source,ts] @@ -2227,6 +2289,7 @@ link:{ref}/cluster-reroute.html[Documentation] + |=== +[discrete] === cluster.state [source,ts] @@ -2280,6 +2343,7 @@ _Default:_ `open` |=== +[discrete] === cluster.stats [source,ts] @@ -2304,6 +2368,7 @@ link:{ref}/cluster-stats.html[Documentation] + |=== +[discrete] === count [source,ts] @@ -2386,6 +2451,7 @@ _Default:_ `OR` |=== +[discrete] === create [source,ts] @@ -2444,6 +2510,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === danglingIndices.deleteDanglingIndex [source,ts] @@ -2472,6 +2539,7 @@ link:{ref}/modules-gateway-dangling-indices.html[Documentation] + |=== +[discrete] === danglingIndices.importDanglingIndex [source,ts] @@ -2500,6 +2568,7 @@ link:{ref}/modules-gateway-dangling-indices.html[Documentation] + |=== +[discrete] === danglingIndices.listDanglingIndices [source,ts] @@ -2509,6 +2578,7 @@ client.danglingIndices.listDanglingIndices() link:{ref}/modules-gateway-dangling-indices.html[Documentation] + +[discrete] === delete [source,ts] @@ -2567,6 +2637,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === deleteByQuery [source,ts] @@ -2730,6 +2801,7 @@ _Default:_ `1` |=== +[discrete] === deleteByQueryRethrottle [source,ts] @@ -2750,6 +2822,7 @@ link:{ref}/docs-delete-by-query.html[Documentation] + |=== +[discrete] === deleteScript [source,ts] @@ -2774,6 +2847,7 @@ link:{ref}/modules-scripting.html[Documentation] + |=== +[discrete] === enrich.deletePolicy [source,ts] @@ -2790,6 +2864,7 @@ link:{ref}/delete-enrich-policy-api.html[Documentation] + |=== +[discrete] === enrich.executePolicy [source,ts] @@ -2811,6 +2886,7 @@ _Default:_ `true` |=== +[discrete] === enrich.getPolicy [source,ts] @@ -2827,6 +2903,7 @@ link:{ref}/get-enrich-policy-api.html[Documentation] + |=== +[discrete] === enrich.putPolicy [source,ts] @@ -2847,6 +2924,7 @@ link:{ref}/put-enrich-policy-api.html[Documentation] + |=== +[discrete] === enrich.stats [source,ts] @@ -2856,6 +2934,7 @@ client.enrich.stats() link:{ref}/enrich-stats-api.html[Documentation] + +[discrete] === eql.delete *Stability:* beta [source,ts] @@ -2872,6 +2951,7 @@ link:{ref}/eql-search-api.html[Documentation] + |=== +[discrete] === eql.get *Stability:* beta [source,ts] @@ -2897,6 +2977,7 @@ _Default:_ `5d` |=== +[discrete] === eql.search *Stability:* beta [source,ts] @@ -2930,6 +3011,7 @@ _Default:_ `5d` |=== +[discrete] === exists [source,ts] @@ -2997,6 +3079,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === existsSource [source,ts] @@ -3059,6 +3142,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === explain [source,ts] @@ -3138,6 +3222,7 @@ _Default:_ `OR` |=== +[discrete] === fieldCaps [source,ts] @@ -3179,6 +3264,7 @@ _Default:_ `open` |=== +[discrete] === get [source,ts] @@ -3246,6 +3332,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === getScript [source,ts] @@ -3266,6 +3353,7 @@ link:{ref}/modules-scripting.html[Documentation] + |=== +[discrete] === getScriptContext *Stability:* experimental [source,ts] @@ -3275,6 +3363,7 @@ client.getScriptContext() link:https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html[Documentation] + +[discrete] === getScriptLanguages *Stability:* experimental [source,ts] @@ -3284,6 +3373,7 @@ client.getScriptLanguages() link:{ref}/modules-scripting.html[Documentation] + +[discrete] === getSource [source,ts] @@ -3346,6 +3436,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === graph.explore [source,ts] @@ -3380,6 +3471,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === ilm.deleteLifecycle [source,ts] @@ -3396,6 +3488,7 @@ link:{ref}/ilm-delete-lifecycle.html[Documentation] + |=== +[discrete] === ilm.explainLifecycle [source,ts] @@ -3420,6 +3513,7 @@ link:{ref}/ilm-explain-lifecycle.html[Documentation] + |=== +[discrete] === ilm.getLifecycle [source,ts] @@ -3436,6 +3530,7 @@ link:{ref}/ilm-get-lifecycle.html[Documentation] + |=== +[discrete] === ilm.getStatus [source,ts] @@ -3445,6 +3540,7 @@ client.ilm.getStatus() link:{ref}/ilm-get-status.html[Documentation] + +[discrete] === ilm.moveToStep [source,ts] @@ -3465,6 +3561,7 @@ link:{ref}/ilm-move-to-step.html[Documentation] + |=== +[discrete] === ilm.putLifecycle [source,ts] @@ -3485,6 +3582,7 @@ link:{ref}/ilm-put-lifecycle.html[Documentation] + |=== +[discrete] === ilm.removePolicy [source,ts] @@ -3501,6 +3599,7 @@ link:{ref}/ilm-remove-policy.html[Documentation] + |=== +[discrete] === ilm.retry [source,ts] @@ -3517,6 +3616,7 @@ link:{ref}/ilm-retry-policy.html[Documentation] + |=== +[discrete] === ilm.start [source,ts] @@ -3526,6 +3626,7 @@ client.ilm.start() link:{ref}/ilm-start.html[Documentation] + +[discrete] === ilm.stop [source,ts] @@ -3535,6 +3636,7 @@ client.ilm.stop() link:{ref}/ilm-stop.html[Documentation] + +[discrete] === index [source,ts] @@ -3609,6 +3711,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === indices.addBlock [source,ts] @@ -3650,6 +3753,7 @@ _Default:_ `open` |=== +[discrete] === indices.analyze [source,ts] @@ -3670,6 +3774,7 @@ link:{ref}/indices-analyze.html[Documentation] + |=== +[discrete] === indices.clearCache [source,ts] @@ -3715,6 +3820,7 @@ _Default:_ `open` |=== +[discrete] === indices.clone [source,ts] @@ -3751,6 +3857,7 @@ link:{ref}/indices-clone-index.html[Documentation] + |=== +[discrete] === indices.close [source,ts] @@ -3792,6 +3899,7 @@ _Default:_ `open` |=== +[discrete] === indices.create [source,ts] @@ -3828,6 +3936,7 @@ link:{ref}/indices-create-index.html[Documentation] + |=== +[discrete] === indices.createDataStream [source,ts] @@ -3844,6 +3953,7 @@ link:{ref}/data-streams.html[Documentation] + |=== +[discrete] === indices.dataStreamsStats [source,ts] @@ -3860,6 +3970,7 @@ link:{ref}/data-streams.html[Documentation] + |=== +[discrete] === indices.delete [source,ts] @@ -3897,6 +4008,7 @@ _Default:_ `open` |=== +[discrete] === indices.deleteAlias [source,ts] @@ -3925,6 +4037,7 @@ link:{ref}/indices-aliases.html[Documentation] + |=== +[discrete] === indices.deleteDataStream [source,ts] @@ -3941,6 +4054,7 @@ link:{ref}/data-streams.html[Documentation] + |=== +[discrete] === indices.deleteIndexTemplate *Stability:* experimental [source,ts] @@ -3965,6 +4079,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.deleteTemplate [source,ts] @@ -3989,6 +4104,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.exists [source,ts] @@ -4030,6 +4146,7 @@ _Default:_ `open` |=== +[discrete] === indices.existsAlias [source,ts] @@ -4067,6 +4184,7 @@ _Default:_ `all` |=== +[discrete] === indices.existsIndexTemplate *Stability:* experimental [source,ts] @@ -4095,6 +4213,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.existsTemplate [source,ts] @@ -4123,6 +4242,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.existsType [source,ts] @@ -4160,6 +4280,7 @@ _Default:_ `open` |=== +[discrete] === indices.flush [source,ts] @@ -4197,6 +4318,7 @@ _Default:_ `open` |=== +[discrete] === indices.flushSynced [source,ts] @@ -4226,6 +4348,7 @@ _Default:_ `open` |=== +[discrete] === indices.forcemerge [source,ts] @@ -4267,6 +4390,7 @@ _Default:_ `open` |=== +[discrete] === indices.freeze [source,ts] @@ -4308,6 +4432,7 @@ _Default:_ `closed` |=== +[discrete] === indices.get [source,ts] @@ -4357,6 +4482,7 @@ _Default:_ `open` |=== +[discrete] === indices.getAlias [source,ts] @@ -4394,6 +4520,7 @@ _Default:_ `all` |=== +[discrete] === indices.getDataStream [source,ts] @@ -4410,6 +4537,7 @@ link:{ref}/data-streams.html[Documentation] + |=== +[discrete] === indices.getFieldMapping [source,ts] @@ -4461,6 +4589,7 @@ _Default:_ `open` |=== +[discrete] === indices.getIndexTemplate *Stability:* experimental [source,ts] @@ -4489,6 +4618,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.getMapping [source,ts] @@ -4538,6 +4668,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === indices.getSettings [source,ts] @@ -4587,6 +4718,7 @@ _Default:_ `all` |=== +[discrete] === indices.getTemplate [source,ts] @@ -4619,6 +4751,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.getUpgrade [source,ts] @@ -4648,6 +4781,7 @@ _Default:_ `open` |=== +[discrete] === indices.open [source,ts] @@ -4689,6 +4823,7 @@ _Default:_ `closed` |=== +[discrete] === indices.putAlias [source,ts] @@ -4721,6 +4856,7 @@ link:{ref}/indices-aliases.html[Documentation] + |=== +[discrete] === indices.putIndexTemplate *Stability:* experimental [source,ts] @@ -4753,6 +4889,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.putMapping [source,ts] @@ -4808,6 +4945,7 @@ _Default:_ `open` |=== +[discrete] === indices.putSettings [source,ts] @@ -4857,6 +4995,7 @@ _Default:_ `open` |=== +[discrete] === indices.putTemplate [source,ts] @@ -4893,6 +5032,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.recovery [source,ts] @@ -4917,6 +5057,7 @@ link:{ref}/indices-recovery.html[Documentation] + |=== +[discrete] === indices.refresh [source,ts] @@ -4946,6 +5087,7 @@ _Default:_ `open` |=== +[discrete] === indices.reloadSearchAnalyzers [source,ts] @@ -4975,6 +5117,7 @@ _Default:_ `open` |=== +[discrete] === indices.resolveIndex *Stability:* experimental [source,ts] @@ -4996,6 +5139,7 @@ _Default:_ `open` |=== +[discrete] === indices.rollover [source,ts] @@ -5040,6 +5184,7 @@ link:{ref}/indices-rollover-index.html[Documentation] + |=== +[discrete] === indices.segments [source,ts] @@ -5073,6 +5218,7 @@ _Default:_ `open` |=== +[discrete] === indices.shardStores [source,ts] @@ -5106,6 +5252,7 @@ _Default:_ `open` |=== +[discrete] === indices.shrink [source,ts] @@ -5146,6 +5293,7 @@ link:{ref}/indices-shrink-index.html[Documentation] + |=== +[discrete] === indices.simulateIndexTemplate *Stability:* experimental [source,ts] @@ -5178,6 +5326,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.simulateTemplate *Stability:* experimental [source,ts] @@ -5210,6 +5359,7 @@ link:{ref}/indices-templates.html[Documentation] + |=== +[discrete] === indices.split [source,ts] @@ -5250,6 +5400,7 @@ link:{ref}/indices-split-index.html[Documentation] + |=== +[discrete] === indices.stats [source,ts] @@ -5313,6 +5464,7 @@ _Default:_ `true` |=== +[discrete] === indices.unfreeze [source,ts] @@ -5354,6 +5506,7 @@ _Default:_ `closed` |=== +[discrete] === indices.updateAliases [source,ts] @@ -5378,6 +5531,7 @@ link:{ref}/indices-aliases.html[Documentation] + |=== +[discrete] === indices.upgrade [source,ts] @@ -5415,6 +5569,7 @@ _Default:_ `open` |=== +[discrete] === indices.validateQuery [source,ts] @@ -5491,6 +5646,7 @@ _Default:_ `OR` |=== +[discrete] === info [source,ts] @@ -5500,6 +5656,7 @@ client.info() link:{ref}/index.html[Documentation] + +[discrete] === ingest.deletePipeline [source,ts] @@ -5524,6 +5681,7 @@ link:{ref}/delete-pipeline-api.html[Documentation] + |=== +[discrete] === ingest.getPipeline [source,ts] @@ -5544,6 +5702,7 @@ link:{ref}/get-pipeline-api.html[Documentation] + |=== +[discrete] === ingest.processorGrok [source,ts] @@ -5553,6 +5712,7 @@ client.ingest.processorGrok() link:{ref}/grok-processor.html#grok-processor-rest-get[Documentation] + +[discrete] === ingest.putPipeline [source,ts] @@ -5581,6 +5741,7 @@ link:{ref}/put-pipeline-api.html[Documentation] + |=== +[discrete] === ingest.simulate [source,ts] @@ -5605,6 +5766,7 @@ link:{ref}/simulate-pipeline-api.html[Documentation] + |=== +[discrete] === license.delete [source,ts] @@ -5614,6 +5776,7 @@ client.license.delete() link:{ref}/delete-license.html[Documentation] + +[discrete] === license.get [source,ts] @@ -5634,6 +5797,7 @@ link:{ref}/get-license.html[Documentation] + |=== +[discrete] === license.getBasicStatus [source,ts] @@ -5643,6 +5807,7 @@ client.license.getBasicStatus() link:{ref}/get-basic-status.html[Documentation] + +[discrete] === license.getTrialStatus [source,ts] @@ -5652,6 +5817,7 @@ client.license.getTrialStatus() link:{ref}/get-trial-status.html[Documentation] + +[discrete] === license.post [source,ts] @@ -5672,6 +5838,7 @@ link:{ref}/update-license.html[Documentation] + |=== +[discrete] === license.postStartBasic [source,ts] @@ -5688,6 +5855,7 @@ link:{ref}/start-basic.html[Documentation] + |=== +[discrete] === license.postStartTrial [source,ts] @@ -5708,6 +5876,7 @@ link:{ref}/start-trial.html[Documentation] + |=== +[discrete] === mget [source,ts] @@ -5766,6 +5935,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === migration.deprecations [source,ts] @@ -5782,6 +5952,7 @@ link:{ref}/migration-api-deprecation.html[Documentation] + |=== +[discrete] === ml.closeJob [source,ts] @@ -5820,6 +5991,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === ml.deleteCalendar [source,ts] @@ -5836,6 +6008,7 @@ link:{ref}/ml-delete-calendar.html[Documentation] + |=== +[discrete] === ml.deleteCalendarEvent [source,ts] @@ -5856,6 +6029,7 @@ link:{ref}/ml-delete-calendar-event.html[Documentation] + |=== +[discrete] === ml.deleteCalendarJob [source,ts] @@ -5876,6 +6050,7 @@ link:{ref}/ml-delete-calendar-job.html[Documentation] + |=== +[discrete] === ml.deleteDataFrameAnalytics *Stability:* experimental [source,ts] @@ -5900,6 +6075,7 @@ link:{ref}/delete-dfanalytics.html[Documentation] + |=== +[discrete] === ml.deleteDatafeed [source,ts] @@ -5920,6 +6096,7 @@ link:{ref}/ml-delete-datafeed.html[Documentation] + |=== +[discrete] === ml.deleteExpiredData [source,ts] @@ -5948,6 +6125,7 @@ link:{ref}/ml-delete-expired-data.html[Documentation] + |=== +[discrete] === ml.deleteFilter [source,ts] @@ -5964,6 +6142,7 @@ link:{ref}/ml-delete-filter.html[Documentation] + |=== +[discrete] === ml.deleteForecast [source,ts] @@ -5992,6 +6171,7 @@ link:{ref}/ml-delete-forecast.html[Documentation] + |=== +[discrete] === ml.deleteJob [source,ts] @@ -6017,6 +6197,7 @@ _Default:_ `true` |=== +[discrete] === ml.deleteModelSnapshot [source,ts] @@ -6037,6 +6218,7 @@ link:{ref}/ml-delete-snapshot.html[Documentation] + |=== +[discrete] === ml.deleteTrainedModel *Stability:* experimental [source,ts] @@ -6053,6 +6235,7 @@ link:{ref}/delete-inference.html[Documentation] + |=== +[discrete] === ml.estimateModelMemory [source,ts] @@ -6069,6 +6252,7 @@ link:{ref}/ml-apis.html[Documentation] + |=== +[discrete] === ml.evaluateDataFrame *Stability:* experimental [source,ts] @@ -6085,6 +6269,7 @@ link:{ref}/evaluate-dfanalytics.html[Documentation] + |=== +[discrete] === ml.explainDataFrameAnalytics *Stability:* experimental [source,ts] @@ -6105,6 +6290,7 @@ link:{ref}/explain-dfanalytics.html[Documentation] + |=== +[discrete] === ml.findFileStructure *Stability:* experimental [source,ts] @@ -6180,6 +6366,7 @@ _Default:_ `25s` |=== +[discrete] === ml.flushJob [source,ts] @@ -6220,6 +6407,7 @@ link:{ref}/ml-flush-job.html[Documentation] + |=== +[discrete] === ml.forecast [source,ts] @@ -6248,6 +6436,7 @@ link:{ref}/ml-forecast.html[Documentation] + |=== +[discrete] === ml.getBuckets [source,ts] @@ -6308,6 +6497,7 @@ link:{ref}/ml-get-bucket.html[Documentation] + |=== +[discrete] === ml.getCalendarEvents [source,ts] @@ -6344,6 +6534,7 @@ link:{ref}/ml-get-calendar-event.html[Documentation] + |=== +[discrete] === ml.getCalendars [source,ts] @@ -6372,6 +6563,7 @@ link:{ref}/ml-get-calendar.html[Documentation] + |=== +[discrete] === ml.getCategories [source,ts] @@ -6408,6 +6600,7 @@ link:{ref}/ml-get-category.html[Documentation] + |=== +[discrete] === ml.getDataFrameAnalytics *Stability:* experimental [source,ts] @@ -6438,6 +6631,7 @@ _Default:_ `100` |=== +[discrete] === ml.getDataFrameAnalyticsStats *Stability:* experimental [source,ts] @@ -6472,6 +6666,7 @@ _Default:_ `100` |=== +[discrete] === ml.getDatafeedStats [source,ts] @@ -6498,6 +6693,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === ml.getDatafeeds [source,ts] @@ -6524,6 +6720,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === ml.getFilters [source,ts] @@ -6548,6 +6745,7 @@ link:{ref}/ml-get-filter.html[Documentation] + |=== +[discrete] === ml.getInfluencers [source,ts] @@ -6600,6 +6798,7 @@ link:{ref}/ml-get-influencer.html[Documentation] + |=== +[discrete] === ml.getJobStats [source,ts] @@ -6626,6 +6825,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === ml.getJobs [source,ts] @@ -6652,6 +6852,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === ml.getModelSnapshots [source,ts] @@ -6700,6 +6901,7 @@ link:{ref}/ml-get-snapshot.html[Documentation] + |=== +[discrete] === ml.getOverallBuckets [source,ts] @@ -6754,6 +6956,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === ml.getRecords [source,ts] @@ -6806,6 +7009,7 @@ link:{ref}/ml-get-record.html[Documentation] + |=== +[discrete] === ml.getTrainedModels *Stability:* experimental [source,ts] @@ -6814,6 +7018,7 @@ client.ml.getTrainedModels({ model_id: string, allow_no_match: boolean, include: string, + include_model_definition: boolean, decompress_definition: boolean, from: number, size: number, @@ -6834,6 +7039,11 @@ _Default:_ `true` |`include` |`string` - A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none. +|`include_model_definition` or `includeModelDefinition` +|`boolean` - Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false. + + +WARNING: This parameter has been deprecated. + |`decompress_definition` or `decompressDefinition` |`boolean` - Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true. + _Default:_ `true` @@ -6853,6 +7063,7 @@ _Default:_ `100` |=== +[discrete] === ml.getTrainedModelsStats *Stability:* experimental [source,ts] @@ -6883,6 +7094,7 @@ _Default:_ `100` |=== +[discrete] === ml.info [source,ts] @@ -6892,6 +7104,7 @@ client.ml.info() link:{ref}/get-ml-info.html[Documentation] + +[discrete] === ml.openJob [source,ts] @@ -6908,6 +7121,7 @@ link:{ref}/ml-open-job.html[Documentation] + |=== +[discrete] === ml.postCalendarEvents [source,ts] @@ -6928,6 +7142,7 @@ link:{ref}/ml-post-calendar-event.html[Documentation] + |=== +[discrete] === ml.postData [source,ts] @@ -6956,6 +7171,7 @@ link:{ref}/ml-post-data.html[Documentation] + |=== +[discrete] === ml.previewDatafeed [source,ts] @@ -6972,6 +7188,7 @@ link:{ref}/ml-preview-datafeed.html[Documentation] + |=== +[discrete] === ml.putCalendar [source,ts] @@ -6992,6 +7209,7 @@ link:{ref}/ml-put-calendar.html[Documentation] + |=== +[discrete] === ml.putCalendarJob [source,ts] @@ -7012,6 +7230,7 @@ link:{ref}/ml-put-calendar-job.html[Documentation] + |=== +[discrete] === ml.putDataFrameAnalytics *Stability:* experimental [source,ts] @@ -7032,6 +7251,7 @@ link:{ref}/put-dfanalytics.html[Documentation] + |=== +[discrete] === ml.putDatafeed [source,ts] @@ -7068,6 +7288,7 @@ link:{ref}/ml-put-datafeed.html[Documentation] + |=== +[discrete] === ml.putFilter [source,ts] @@ -7088,6 +7309,7 @@ link:{ref}/ml-put-filter.html[Documentation] + |=== +[discrete] === ml.putJob [source,ts] @@ -7108,6 +7330,7 @@ link:{ref}/ml-put-job.html[Documentation] + |=== +[discrete] === ml.putTrainedModel *Stability:* experimental [source,ts] @@ -7128,6 +7351,7 @@ link:{ref}/put-inference.html[Documentation] + |=== +[discrete] === ml.revertModelSnapshot [source,ts] @@ -7156,6 +7380,7 @@ link:{ref}/ml-revert-snapshot.html[Documentation] + |=== +[discrete] === ml.setUpgradeMode [source,ts] @@ -7176,6 +7401,7 @@ link:{ref}/ml-set-upgrade-mode.html[Documentation] + |=== +[discrete] === ml.startDataFrameAnalytics *Stability:* experimental [source,ts] @@ -7200,6 +7426,7 @@ link:{ref}/start-dfanalytics.html[Documentation] + |=== +[discrete] === ml.startDatafeed [source,ts] @@ -7232,6 +7459,7 @@ link:{ref}/ml-start-datafeed.html[Documentation] + |=== +[discrete] === ml.stopDataFrameAnalytics *Stability:* experimental [source,ts] @@ -7264,6 +7492,7 @@ link:{ref}/stop-dfanalytics.html[Documentation] + |=== +[discrete] === ml.stopDatafeed [source,ts] @@ -7302,6 +7531,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === ml.updateDataFrameAnalytics *Stability:* experimental [source,ts] @@ -7322,6 +7552,7 @@ link:{ref}/update-dfanalytics.html[Documentation] + |=== +[discrete] === ml.updateDatafeed [source,ts] @@ -7358,6 +7589,7 @@ link:{ref}/ml-update-datafeed.html[Documentation] + |=== +[discrete] === ml.updateFilter [source,ts] @@ -7378,6 +7610,7 @@ link:{ref}/ml-update-filter.html[Documentation] + |=== +[discrete] === ml.updateJob [source,ts] @@ -7398,6 +7631,7 @@ link:{ref}/ml-update-job.html[Documentation] + |=== +[discrete] === ml.updateModelSnapshot [source,ts] @@ -7422,6 +7656,7 @@ link:{ref}/ml-update-snapshot.html[Documentation] + |=== +[discrete] === ml.validate [source,ts] @@ -7438,6 +7673,7 @@ link:https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html[Docum |=== +[discrete] === ml.validateDetector [source,ts] @@ -7454,6 +7690,7 @@ link:https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html[Docum |=== +[discrete] === monitoring.bulk *Stability:* experimental [source,ts] @@ -7488,6 +7725,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === msearch [source,ts] @@ -7543,6 +7781,7 @@ _Default:_ `true` |=== +[discrete] === msearchTemplate [source,ts] @@ -7588,6 +7827,7 @@ _Default:_ `true` |=== +[discrete] === mtermvectors [source,ts] @@ -7664,6 +7904,7 @@ _Default:_ `true` |=== +[discrete] === nodes.hotThreads [source,ts] @@ -7704,6 +7945,7 @@ link:{ref}/cluster-nodes-hot-threads.html[Documentation] + |=== +[discrete] === nodes.info [source,ts] @@ -7732,6 +7974,7 @@ link:{ref}/cluster-nodes-info.html[Documentation] + |=== +[discrete] === nodes.reloadSecureSettings [source,ts] @@ -7756,6 +7999,7 @@ link:{ref}/secure-settings.html#reloadable-secure-settings[Documentation] + |=== +[discrete] === nodes.stats [source,ts] @@ -7813,6 +8057,7 @@ _Default:_ `node` |=== +[discrete] === nodes.usage [source,ts] @@ -7837,6 +8082,7 @@ link:{ref}/cluster-nodes-usage.html[Documentation] + |=== +[discrete] === openPointInTime [source,ts] @@ -7874,6 +8120,7 @@ _Default:_ `open` |=== +[discrete] === ping [source,ts] @@ -7883,6 +8130,7 @@ client.ping() link:{ref}/index.html[Documentation] + +[discrete] === putScript [source,ts] @@ -7915,6 +8163,7 @@ link:{ref}/modules-scripting.html[Documentation] + |=== +[discrete] === rankEval *Stability:* experimental [source,ts] @@ -7952,6 +8201,7 @@ _Default:_ `open` |=== +[discrete] === reindex [source,ts] @@ -8005,6 +8255,7 @@ _Default:_ `1` |=== +[discrete] === reindexRethrottle [source,ts] @@ -8025,6 +8276,7 @@ link:{ref}/docs-reindex.html[Documentation] + |=== +[discrete] === renderSearchTemplate [source,ts] @@ -8045,6 +8297,7 @@ link:{ref}/search-template.html#_validating_templates[Documentation] + |=== +[discrete] === rollup.deleteJob *Stability:* experimental [source,ts] @@ -8061,6 +8314,7 @@ link:{ref}/rollup-delete-job.html[Documentation] + |=== +[discrete] === rollup.getJobs *Stability:* experimental [source,ts] @@ -8077,6 +8331,7 @@ link:{ref}/rollup-get-job.html[Documentation] + |=== +[discrete] === rollup.getRollupCaps *Stability:* experimental [source,ts] @@ -8093,6 +8348,7 @@ link:{ref}/rollup-get-rollup-caps.html[Documentation] + |=== +[discrete] === rollup.getRollupIndexCaps *Stability:* experimental [source,ts] @@ -8109,6 +8365,7 @@ link:{ref}/rollup-get-rollup-index-caps.html[Documentation] + |=== +[discrete] === rollup.putJob *Stability:* experimental [source,ts] @@ -8129,6 +8386,7 @@ link:{ref}/rollup-put-job.html[Documentation] + |=== +[discrete] === rollup.rollupSearch *Stability:* experimental [source,ts] @@ -8163,6 +8421,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === rollup.startJob *Stability:* experimental [source,ts] @@ -8179,6 +8438,7 @@ link:{ref}/rollup-start-job.html[Documentation] + |=== +[discrete] === rollup.stopJob *Stability:* experimental [source,ts] @@ -8203,6 +8463,7 @@ link:{ref}/rollup-stop-job.html[Documentation] + |=== +[discrete] === scriptsPainlessExecute *Stability:* experimental [source,ts] @@ -8219,6 +8480,7 @@ link:https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-exec |=== +[discrete] === scroll [source,ts] @@ -8250,6 +8512,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === search [source,ts] @@ -8450,6 +8713,7 @@ _Default:_ `5` |=== +[discrete] === searchShards [source,ts] @@ -8491,6 +8755,7 @@ _Default:_ `open` |=== +[discrete] === searchTemplate [source,ts] @@ -8569,6 +8834,7 @@ _Default:_ `true` |=== +[discrete] === searchableSnapshots.clearCache *Stability:* experimental [source,ts] @@ -8598,6 +8864,7 @@ _Default:_ `open` |=== +[discrete] === searchableSnapshots.mount *Stability:* experimental [source,ts] @@ -8630,6 +8897,7 @@ link:{ref}/searchable-snapshots-api-mount-snapshot.html[Documentation] + |=== +[discrete] === searchableSnapshots.repositoryStats *Stability:* experimental [source,ts] @@ -8646,6 +8914,7 @@ link:{ref}/searchable-snapshots-apis.html[Documentation] + |=== +[discrete] === searchableSnapshots.stats *Stability:* experimental [source,ts] @@ -8662,6 +8931,7 @@ link:{ref}/searchable-snapshots-apis.html[Documentation] + |=== +[discrete] === security.authenticate [source,ts] @@ -8671,6 +8941,7 @@ client.security.authenticate() link:{ref}/security-api-authenticate.html[Documentation] + +[discrete] === security.changePassword [source,ts] @@ -8695,6 +8966,7 @@ link:{ref}/security-api-change-password.html[Documentation] + |=== +[discrete] === security.clearCachedPrivileges [source,ts] @@ -8711,6 +8983,7 @@ link:{ref}/security-api-clear-privilege-cache.html[Documentation] + |=== +[discrete] === security.clearCachedRealms [source,ts] @@ -8731,6 +9004,7 @@ link:{ref}/security-api-clear-cache.html[Documentation] + |=== +[discrete] === security.clearCachedRoles [source,ts] @@ -8747,6 +9021,7 @@ link:{ref}/security-api-clear-role-cache.html[Documentation] + |=== +[discrete] === security.createApiKey [source,ts] @@ -8767,6 +9042,7 @@ link:{ref}/security-api-create-api-key.html[Documentation] + |=== +[discrete] === security.deletePrivileges [source,ts] @@ -8791,6 +9067,7 @@ link:{ref}/security-api-delete-privilege.html[Documentation] + |=== +[discrete] === security.deleteRole [source,ts] @@ -8811,6 +9088,7 @@ link:{ref}/security-api-delete-role.html[Documentation] + |=== +[discrete] === security.deleteRoleMapping [source,ts] @@ -8831,6 +9109,7 @@ link:{ref}/security-api-delete-role-mapping.html[Documentation] + |=== +[discrete] === security.deleteUser [source,ts] @@ -8851,6 +9130,7 @@ link:{ref}/security-api-delete-user.html[Documentation] + |=== +[discrete] === security.disableUser [source,ts] @@ -8871,6 +9151,7 @@ link:{ref}/security-api-disable-user.html[Documentation] + |=== +[discrete] === security.enableUser [source,ts] @@ -8891,6 +9172,7 @@ link:{ref}/security-api-enable-user.html[Documentation] + |=== +[discrete] === security.getApiKey [source,ts] @@ -8923,6 +9205,7 @@ link:{ref}/security-api-get-api-key.html[Documentation] + |=== +[discrete] === security.getBuiltinPrivileges [source,ts] @@ -8932,6 +9215,7 @@ client.security.getBuiltinPrivileges() link:{ref}/security-api-get-builtin-privileges.html[Documentation] + +[discrete] === security.getPrivileges [source,ts] @@ -8952,6 +9236,7 @@ link:{ref}/security-api-get-privileges.html[Documentation] + |=== +[discrete] === security.getRole [source,ts] @@ -8968,6 +9253,7 @@ link:{ref}/security-api-get-role.html[Documentation] + |=== +[discrete] === security.getRoleMapping [source,ts] @@ -8984,6 +9270,7 @@ link:{ref}/security-api-get-role-mapping.html[Documentation] + |=== +[discrete] === security.getToken [source,ts] @@ -9000,6 +9287,7 @@ link:{ref}/security-api-get-token.html[Documentation] + |=== +[discrete] === security.getUser [source,ts] @@ -9016,6 +9304,7 @@ link:{ref}/security-api-get-user.html[Documentation] + |=== +[discrete] === security.getUserPrivileges [source,ts] @@ -9025,6 +9314,7 @@ client.security.getUserPrivileges() link:{ref}/security-api-get-privileges.html[Documentation] + +[discrete] === security.hasPrivileges [source,ts] @@ -9045,6 +9335,7 @@ link:{ref}/security-api-has-privileges.html[Documentation] + |=== +[discrete] === security.invalidateApiKey [source,ts] @@ -9061,6 +9352,7 @@ link:{ref}/security-api-invalidate-api-key.html[Documentation] + |=== +[discrete] === security.invalidateToken [source,ts] @@ -9077,6 +9369,7 @@ link:{ref}/security-api-invalidate-token.html[Documentation] + |=== +[discrete] === security.putPrivileges [source,ts] @@ -9097,6 +9390,7 @@ link:{ref}/security-api-put-privileges.html[Documentation] + |=== +[discrete] === security.putRole [source,ts] @@ -9121,6 +9415,7 @@ link:{ref}/security-api-put-role.html[Documentation] + |=== +[discrete] === security.putRoleMapping [source,ts] @@ -9145,6 +9440,7 @@ link:{ref}/security-api-put-role-mapping.html[Documentation] + |=== +[discrete] === security.putUser [source,ts] @@ -9169,6 +9465,7 @@ link:{ref}/security-api-put-user.html[Documentation] + |=== +[discrete] === slm.deleteLifecycle [source,ts] @@ -9185,6 +9482,7 @@ link:{ref}/slm-api-delete-policy.html[Documentation] + |=== +[discrete] === slm.executeLifecycle [source,ts] @@ -9201,6 +9499,7 @@ link:{ref}/slm-api-execute-lifecycle.html[Documentation] + |=== +[discrete] === slm.executeRetention [source,ts] @@ -9210,6 +9509,7 @@ client.slm.executeRetention() link:{ref}/slm-api-execute-retention.html[Documentation] + +[discrete] === slm.getLifecycle [source,ts] @@ -9226,6 +9526,7 @@ link:{ref}/slm-api-get-policy.html[Documentation] + |=== +[discrete] === slm.getStats [source,ts] @@ -9235,6 +9536,7 @@ client.slm.getStats() link:{ref}/slm-api-get-stats.html[Documentation] + +[discrete] === slm.getStatus [source,ts] @@ -9244,6 +9546,7 @@ client.slm.getStatus() link:{ref}/slm-api-get-status.html[Documentation] + +[discrete] === slm.putLifecycle [source,ts] @@ -9264,6 +9567,7 @@ link:{ref}/slm-api-put-policy.html[Documentation] + |=== +[discrete] === slm.start [source,ts] @@ -9273,6 +9577,7 @@ client.slm.start() link:{ref}/slm-api-start.html[Documentation] + +[discrete] === slm.stop [source,ts] @@ -9282,6 +9587,7 @@ client.slm.stop() link:{ref}/slm-api-stop.html[Documentation] + +[discrete] === snapshot.cleanupRepository [source,ts] @@ -9306,6 +9612,7 @@ link:{ref}/clean-up-snapshot-repo-api.html[Documentation] + |=== +[discrete] === snapshot.create [source,ts] @@ -9338,6 +9645,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === snapshot.createRepository [source,ts] @@ -9370,6 +9678,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === snapshot.delete [source,ts] @@ -9394,6 +9703,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === snapshot.deleteRepository [source,ts] @@ -9418,6 +9728,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === snapshot.get [source,ts] @@ -9450,6 +9761,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === snapshot.getRepository [source,ts] @@ -9474,6 +9786,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === snapshot.restore [source,ts] @@ -9506,6 +9819,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === snapshot.status [source,ts] @@ -9534,6 +9848,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === snapshot.verifyRepository [source,ts] @@ -9558,6 +9873,7 @@ link:{ref}/modules-snapshots.html[Documentation] + |=== +[discrete] === sql.clearCursor [source,ts] @@ -9574,6 +9890,7 @@ link:{ref}/sql-pagination.html[Documentation] + |=== +[discrete] === sql.query [source,ts] @@ -9595,6 +9912,7 @@ link:{ref}/sql-rest-overview.html[Documentation] + |=== +[discrete] === sql.translate [source,ts] @@ -9611,6 +9929,7 @@ link:{ref}/sql-translate.html[Documentation] + |=== +[discrete] === ssl.certificates [source,ts] @@ -9620,6 +9939,7 @@ client.ssl.certificates() link:{ref}/security-api-ssl.html[Documentation] + +[discrete] === tasks.cancel [source,ts] @@ -9652,6 +9972,7 @@ link:{ref}/tasks.html[Documentation] + |=== +[discrete] === tasks.get [source,ts] @@ -9676,6 +9997,7 @@ link:{ref}/tasks.html[Documentation] + |=== +[discrete] === tasks.list [source,ts] @@ -9717,6 +10039,7 @@ _Default:_ `nodes` |=== +[discrete] === termvectors [source,ts] @@ -9793,6 +10116,7 @@ _Default:_ `true` |=== +[discrete] === transform.deleteTransform [source,ts] @@ -9813,6 +10137,7 @@ link:{ref}/delete-transform.html[Documentation] + |=== +[discrete] === transform.getTransform [source,ts] @@ -9841,6 +10166,7 @@ link:{ref}/get-transform.html[Documentation] + |=== +[discrete] === transform.getTransformStats [source,ts] @@ -9869,6 +10195,7 @@ link:{ref}/get-transform-stats.html[Documentation] + |=== +[discrete] === transform.previewTransform [source,ts] @@ -9885,6 +10212,7 @@ link:{ref}/preview-transform.html[Documentation] + |=== +[discrete] === transform.putTransform [source,ts] @@ -9909,6 +10237,7 @@ link:{ref}/put-transform.html[Documentation] + |=== +[discrete] === transform.startTransform [source,ts] @@ -9929,6 +10258,7 @@ link:{ref}/start-transform.html[Documentation] + |=== +[discrete] === transform.stopTransform [source,ts] @@ -9965,6 +10295,7 @@ link:{ref}/stop-transform.html[Documentation] + |=== +[discrete] === transform.updateTransform [source,ts] @@ -9989,6 +10320,7 @@ link:{ref}/update-transform.html[Documentation] + |=== +[discrete] === update [source,ts] @@ -10068,6 +10400,7 @@ WARNING: This parameter has been deprecated. |=== +[discrete] === updateByQuery [source,ts] @@ -10240,6 +10573,7 @@ _Default:_ `1` |=== +[discrete] === updateByQueryRethrottle [source,ts] @@ -10260,6 +10594,7 @@ link:{ref}/docs-update-by-query.html[Documentation] + |=== +[discrete] === watcher.ackWatch [source,ts] @@ -10280,6 +10615,7 @@ link:{ref}/watcher-api-ack-watch.html[Documentation] + |=== +[discrete] === watcher.activateWatch [source,ts] @@ -10296,6 +10632,7 @@ link:{ref}/watcher-api-activate-watch.html[Documentation] + |=== +[discrete] === watcher.deactivateWatch [source,ts] @@ -10312,6 +10649,7 @@ link:{ref}/watcher-api-deactivate-watch.html[Documentation] + |=== +[discrete] === watcher.deleteWatch [source,ts] @@ -10328,6 +10666,7 @@ link:{ref}/watcher-api-delete-watch.html[Documentation] + |=== +[discrete] === watcher.executeWatch [source,ts] @@ -10352,6 +10691,7 @@ link:{ref}/watcher-api-execute-watch.html[Documentation] + |=== +[discrete] === watcher.getWatch [source,ts] @@ -10368,6 +10708,7 @@ link:{ref}/watcher-api-get-watch.html[Documentation] + |=== +[discrete] === watcher.putWatch [source,ts] @@ -10404,6 +10745,7 @@ link:{ref}/watcher-api-put-watch.html[Documentation] + |=== +[discrete] === watcher.start [source,ts] @@ -10413,6 +10755,7 @@ client.watcher.start() link:{ref}/watcher-api-start.html[Documentation] + +[discrete] === watcher.stats [source,ts] @@ -10433,6 +10776,7 @@ link:{ref}/watcher-api-stats.html[Documentation] + |=== +[discrete] === watcher.stop [source,ts] @@ -10442,6 +10786,7 @@ client.watcher.stop() link:{ref}/watcher-api-stop.html[Documentation] + +[discrete] === xpack.info [source,ts] @@ -10462,6 +10807,7 @@ link:{ref}/info-api.html[Documentation] + |=== +[discrete] === xpack.usage [source,ts]