API generation
This commit is contained in:
delvedor
@ -3112,7 +3112,9 @@ _Default:_ `open`
|
||||
|`string` - Specify timeout for connection to master
|
||||
|
||||
|`local`
|
||||
|`boolean` - Return local information, do not retrieve the state from master node (default: false)
|
||||
|`boolean` - Return local information, do not retrieve the state from master node (default: false) +
|
||||
|
||||
WARNING: This parameter has been deprecated.
|
||||
|
||||
|===
|
||||
|
||||
@ -3676,6 +3678,38 @@ link:{ref}/indices-templates.html[Documentation] +
|
||||
|
||||
|===
|
||||
|
||||
=== indices.simulateTemplate
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.indices.simulateTemplate({
|
||||
name: string,
|
||||
create: boolean,
|
||||
cause: string,
|
||||
master_timeout: string,
|
||||
body: object
|
||||
})
|
||||
----
|
||||
link:{ref}/indices-templates.html[Documentation] +
|
||||
[cols=2*]
|
||||
|===
|
||||
|`name`
|
||||
|`string` - The name of the index template
|
||||
|
||||
|`create`
|
||||
|`boolean` - Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
|
||||
|
||||
|`cause`
|
||||
|`string` - User defined reason for dry-run creating the new template for simulation purposes
|
||||
|
||||
|`master_timeout` or `masterTimeout`
|
||||
|`string` - Specify timeout for connection to master
|
||||
|
||||
|`body`
|
||||
|`object` - New index template definition to be simulated, if no index template name is specified
|
||||
|
||||
|===
|
||||
|
||||
=== indices.split
|
||||
|
||||
[source,ts]
|
||||
@ -4671,7 +4705,7 @@ client.search({
|
||||
suggest_text: string,
|
||||
timeout: string,
|
||||
track_scores: boolean,
|
||||
track_total_hits: boolean,
|
||||
track_total_hits: boolean|long,
|
||||
allow_partial_search_results: boolean,
|
||||
typed_keys: boolean,
|
||||
version: boolean,
|
||||
@ -4792,7 +4826,7 @@ _Default:_ `missing`
|
||||
|`boolean` - Whether to calculate and return scores even if they are not used for sorting
|
||||
|
||||
|`track_total_hits` or `trackTotalHits`
|
||||
|`boolean` - Indicate if the number of documents that match the query should be tracked
|
||||
|`boolean\|long` - Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
|
||||
|
||||
|`allow_partial_search_results` or `allowPartialSearchResults`
|
||||
|`boolean` - Indicate if an error should be returned if there is a partial search failure or timeout +
|
||||
@ -5038,7 +5072,7 @@ link:{ref}/modules-snapshots.html[Documentation] +
|
||||
----
|
||||
client.snapshot.delete({
|
||||
repository: string,
|
||||
snapshot: string,
|
||||
snapshot: string | string[],
|
||||
master_timeout: string
|
||||
})
|
||||
----
|
||||
@ -5049,7 +5083,7 @@ link:{ref}/modules-snapshots.html[Documentation] +
|
||||
|`string` - A repository name
|
||||
|
||||
|`snapshot`
|
||||
|`string` - A snapshot name
|
||||
|`string \| string[]` - A comma-separated list of snapshot names
|
||||
|
||||
|`master_timeout` or `masterTimeout`
|
||||
|`string` - Explicit operation timeout for connection to master node
|
||||
@ -5070,7 +5104,7 @@ link:{ref}/modules-snapshots.html[Documentation] +
|
||||
[cols=2*]
|
||||
|===
|
||||
|`repository`
|
||||
|`string \| string[]` - A comma-separated list of repository names
|
||||
|`string \| string[]` - Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.
|
||||
|
||||
|`master_timeout` or `masterTimeout`
|
||||
|`string` - Explicit operation timeout for connection to master node
|
||||
@ -5733,7 +5767,7 @@ client.asyncSearch.submit({
|
||||
suggest_text: string,
|
||||
timeout: string,
|
||||
track_scores: boolean,
|
||||
track_total_hits: boolean,
|
||||
track_total_hits: boolean|long,
|
||||
allow_partial_search_results: boolean,
|
||||
typed_keys: boolean,
|
||||
version: boolean,
|
||||
@ -5860,7 +5894,7 @@ _Default:_ `missing`
|
||||
|`boolean` - Whether to calculate and return scores even if they are not used for sorting
|
||||
|
||||
|`track_total_hits` or `trackTotalHits`
|
||||
|`boolean` - Indicate if the number of documents that match the query should be tracked
|
||||
|`boolean\|long` - Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
|
||||
|
||||
|`allow_partial_search_results` or `allowPartialSearchResults`
|
||||
|`boolean` - Indicate if an error should be returned if there is a partial search failure or timeout +
|
||||
@ -7254,10 +7288,17 @@ link:{ref}/ml-delete-datafeed.html[Documentation] +
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.ml.deleteExpiredData()
|
||||
client.ml.deleteExpiredData({
|
||||
body: object
|
||||
})
|
||||
----
|
||||
link:{ref}/ml-delete-expired-data.html[Documentation] +
|
||||
[cols=2*]
|
||||
|===
|
||||
|`body`
|
||||
|`object` - deleting expired data parameters
|
||||
|
||||
|===
|
||||
|
||||
=== ml.deleteFilter
|
||||
|
||||
@ -7538,7 +7579,8 @@ link:{ref}/ml-flush-job.html[Documentation] +
|
||||
client.ml.forecast({
|
||||
job_id: string,
|
||||
duration: string,
|
||||
expires_in: string
|
||||
expires_in: string,
|
||||
max_model_memory: string
|
||||
})
|
||||
----
|
||||
link:{ref}/ml-forecast.html[Documentation] +
|
||||
@ -7553,6 +7595,9 @@ link:{ref}/ml-forecast.html[Documentation] +
|
||||
|`expires_in` or `expiresIn`
|
||||
|`string` - The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
|
||||
|
||||
|`max_model_memory` or `maxModelMemory`
|
||||
|`string` - The max memory able to be used by the forecast. Default is 20mb.
|
||||
|
||||
|===
|
||||
|
||||
=== ml.getBuckets
|
||||
@ -8086,7 +8131,8 @@ client.ml.getTrainedModels({
|
||||
decompress_definition: boolean,
|
||||
from: number,
|
||||
size: number,
|
||||
tags: string | string[]
|
||||
tags: string | string[],
|
||||
for_export: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/get-inference.html[Documentation] +
|
||||
@ -8116,6 +8162,9 @@ _Default:_ `100`
|
||||
|`tags`
|
||||
|`string \| string[]` - A comma-separated list of tags that the model must have.
|
||||
|
||||
|`for_export` or `forExport`
|
||||
|`boolean` - Omits fields that are illegal to set on model PUT
|
||||
|
||||
|===
|
||||
|
||||
=== ml.getTrainedModelsStats
|
||||
@ -9253,14 +9302,14 @@ link:{ref}/security-api-get-privileges.html[Documentation] +
|
||||
[source,ts]
|
||||
----
|
||||
client.security.getRole({
|
||||
name: string
|
||||
name: string | string[]
|
||||
})
|
||||
----
|
||||
link:{ref}/security-api-get-role.html[Documentation] +
|
||||
[cols=2*]
|
||||
|===
|
||||
|`name`
|
||||
|`string` - Role name
|
||||
|`string \| string[]` - A comma-separated list of role names
|
||||
|
||||
|===
|
||||
|
||||
@ -9269,14 +9318,14 @@ link:{ref}/security-api-get-role.html[Documentation] +
|
||||
[source,ts]
|
||||
----
|
||||
client.security.getRoleMapping({
|
||||
name: string
|
||||
name: string | string[]
|
||||
})
|
||||
----
|
||||
link:{ref}/security-api-get-role-mapping.html[Documentation] +
|
||||
[cols=2*]
|
||||
|===
|
||||
|`name`
|
||||
|`string` - Role-Mapping name
|
||||
|`string \| string[]` - A comma-separated list of role-mapping names
|
||||
|
||||
|===
|
||||
|
||||
|
||||
Reference in New Issue
Block a user