1 2 3[[Elasticsearch_Namespaces_IndicesNamespace]] 4=== Elasticsearch\Namespaces\IndicesNamespace 5 6 7 8Class IndicesNamespace 9 10*Description* 11 12 13NOTE: this file is autogenerated using util/GenerateEndpoints.php 14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7) 15 16 17*Methods* 18 19The class defines the following methods: 20 21* <<Elasticsearch_Namespaces_IndicesNamespaceaddBlock_addBlock,`addBlock()`>> 22* <<Elasticsearch_Namespaces_IndicesNamespaceanalyze_analyze,`analyze()`>> 23* <<Elasticsearch_Namespaces_IndicesNamespaceclearCache_clearCache,`clearCache()`>> 24* <<Elasticsearch_Namespaces_IndicesNamespaceclone_clone,`clone()`>> 25* <<Elasticsearch_Namespaces_IndicesNamespaceclose_close,`close()`>> 26* <<Elasticsearch_Namespaces_IndicesNamespacecreate_create,`create()`>> 27* <<Elasticsearch_Namespaces_IndicesNamespacecreateDataStream_createDataStream,`createDataStream()`>> 28* <<Elasticsearch_Namespaces_IndicesNamespacedataStreamsStats_dataStreamsStats,`dataStreamsStats()`>> 29* <<Elasticsearch_Namespaces_IndicesNamespacedelete_delete,`delete()`>> 30* <<Elasticsearch_Namespaces_IndicesNamespacedeleteAlias_deleteAlias,`deleteAlias()`>> 31* <<Elasticsearch_Namespaces_IndicesNamespacedeleteDataStream_deleteDataStream,`deleteDataStream()`>> 32* <<Elasticsearch_Namespaces_IndicesNamespacedeleteIndexTemplate_deleteIndexTemplate,`deleteIndexTemplate()`>> 33* <<Elasticsearch_Namespaces_IndicesNamespacedeleteTemplate_deleteTemplate,`deleteTemplate()`>> 34* <<Elasticsearch_Namespaces_IndicesNamespaceexists_exists,`exists()`>> 35* <<Elasticsearch_Namespaces_IndicesNamespaceexistsAlias_existsAlias,`existsAlias()`>> 36* <<Elasticsearch_Namespaces_IndicesNamespaceexistsIndexTemplate_existsIndexTemplate,`existsIndexTemplate()`>> 37* <<Elasticsearch_Namespaces_IndicesNamespaceexistsTemplate_existsTemplate,`existsTemplate()`>> 38* <<Elasticsearch_Namespaces_IndicesNamespaceexistsType_existsType,`existsType()`>> 39* <<Elasticsearch_Namespaces_IndicesNamespaceflush_flush,`flush()`>> 40* <<Elasticsearch_Namespaces_IndicesNamespaceflushSynced_flushSynced,`flushSynced()`>> 41* <<Elasticsearch_Namespaces_IndicesNamespaceforcemerge_forcemerge,`forcemerge()`>> 42* <<Elasticsearch_Namespaces_IndicesNamespacefreeze_freeze,`freeze()`>> 43* <<Elasticsearch_Namespaces_IndicesNamespaceget_get,`get()`>> 44* <<Elasticsearch_Namespaces_IndicesNamespacegetAlias_getAlias,`getAlias()`>> 45* <<Elasticsearch_Namespaces_IndicesNamespacegetDataStream_getDataStream,`getDataStream()`>> 46* <<Elasticsearch_Namespaces_IndicesNamespacegetFieldMapping_getFieldMapping,`getFieldMapping()`>> 47* <<Elasticsearch_Namespaces_IndicesNamespacegetIndexTemplate_getIndexTemplate,`getIndexTemplate()`>> 48* <<Elasticsearch_Namespaces_IndicesNamespacegetMapping_getMapping,`getMapping()`>> 49* <<Elasticsearch_Namespaces_IndicesNamespacegetSettings_getSettings,`getSettings()`>> 50* <<Elasticsearch_Namespaces_IndicesNamespacegetTemplate_getTemplate,`getTemplate()`>> 51* <<Elasticsearch_Namespaces_IndicesNamespacegetUpgrade_getUpgrade,`getUpgrade()`>> 52* <<Elasticsearch_Namespaces_IndicesNamespacemigrateToDataStream_migrateToDataStream,`migrateToDataStream()`>> 53* <<Elasticsearch_Namespaces_IndicesNamespaceopen_open,`open()`>> 54* <<Elasticsearch_Namespaces_IndicesNamespacepromoteDataStream_promoteDataStream,`promoteDataStream()`>> 55* <<Elasticsearch_Namespaces_IndicesNamespaceputAlias_putAlias,`putAlias()`>> 56* <<Elasticsearch_Namespaces_IndicesNamespaceputIndexTemplate_putIndexTemplate,`putIndexTemplate()`>> 57* <<Elasticsearch_Namespaces_IndicesNamespaceputMapping_putMapping,`putMapping()`>> 58* <<Elasticsearch_Namespaces_IndicesNamespaceputSettings_putSettings,`putSettings()`>> 59* <<Elasticsearch_Namespaces_IndicesNamespaceputTemplate_putTemplate,`putTemplate()`>> 60* <<Elasticsearch_Namespaces_IndicesNamespacerecovery_recovery,`recovery()`>> 61* <<Elasticsearch_Namespaces_IndicesNamespacerefresh_refresh,`refresh()`>> 62* <<Elasticsearch_Namespaces_IndicesNamespacereloadSearchAnalyzers_reloadSearchAnalyzers,`reloadSearchAnalyzers()`>> 63* <<Elasticsearch_Namespaces_IndicesNamespaceresolveIndex_resolveIndex,`resolveIndex()`>> 64* <<Elasticsearch_Namespaces_IndicesNamespacerollover_rollover,`rollover()`>> 65* <<Elasticsearch_Namespaces_IndicesNamespacesegments_segments,`segments()`>> 66* <<Elasticsearch_Namespaces_IndicesNamespaceshardStores_shardStores,`shardStores()`>> 67* <<Elasticsearch_Namespaces_IndicesNamespaceshrink_shrink,`shrink()`>> 68* <<Elasticsearch_Namespaces_IndicesNamespacesimulateIndexTemplate_simulateIndexTemplate,`simulateIndexTemplate()`>> 69* <<Elasticsearch_Namespaces_IndicesNamespacesimulateTemplate_simulateTemplate,`simulateTemplate()`>> 70* <<Elasticsearch_Namespaces_IndicesNamespacesplit_split,`split()`>> 71* <<Elasticsearch_Namespaces_IndicesNamespacestats_stats,`stats()`>> 72* <<Elasticsearch_Namespaces_IndicesNamespaceunfreeze_unfreeze,`unfreeze()`>> 73* <<Elasticsearch_Namespaces_IndicesNamespaceupdateAliases_updateAliases,`updateAliases()`>> 74* <<Elasticsearch_Namespaces_IndicesNamespaceupgrade_upgrade,`upgrade()`>> 75* <<Elasticsearch_Namespaces_IndicesNamespacevalidateQuery_validateQuery,`validateQuery()`>> 76* <<Elasticsearch_Namespaces_IndicesNamespacegetAliases_getAliases,`getAliases()`>> 77 78 79 80[[Elasticsearch_Namespaces_IndicesNamespaceaddBlock_addBlock]] 81.`addBlock(array $params = [])` 82**** 83[source,php] 84---- 85/* 86$params['index'] = (list) A comma separated list of indices to add a block to 87$params['block'] = (string) The block to add (one of read, write, read_only or metadata) 88$params['timeout'] = (time) Explicit operation timeout 89$params['master_timeout'] = (time) Specify timeout for connection to master 90$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 91$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 92$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 93*/ 94---- 95**** 96 97 98 99[[Elasticsearch_Namespaces_IndicesNamespaceanalyze_analyze]] 100.`analyze(array $params = [])` 101**** 102[source,php] 103---- 104/* 105$params['index'] = (string) The name of the index to scope the operation 106$params['body'] = (array) Define analyzer/tokenizer parameters and the text on which the analysis should be performed 107*/ 108---- 109**** 110 111 112 113[[Elasticsearch_Namespaces_IndicesNamespaceclearCache_clearCache]] 114.`clearCache(array $params = [])` 115**** 116[source,php] 117---- 118/* 119$params['index'] = (list) A comma-separated list of index name to limit the operation 120$params['fielddata'] = (boolean) Clear field data 121$params['fields'] = (list) A comma-separated list of fields to clear when using the `fielddata` parameter (default: all) 122$params['query'] = (boolean) Clear query caches 123$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 124$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 125$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 126$params['request'] = (boolean) Clear request cache 127*/ 128---- 129**** 130 131 132 133[[Elasticsearch_Namespaces_IndicesNamespaceclone_clone]] 134.`clone(array $params = [])` 135**** 136[source,php] 137---- 138/* 139$params['index'] = (string) The name of the source index to clone 140$params['target'] = (string) The name of the target index to clone into 141$params['timeout'] = (time) Explicit operation timeout 142$params['master_timeout'] = (time) Specify timeout for connection to master 143$params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the cloned index before the operation returns. 144*/ 145---- 146**** 147 148 149 150[[Elasticsearch_Namespaces_IndicesNamespaceclose_close]] 151.`close(array $params = [])` 152**** 153[source,php] 154---- 155/* 156$params['index'] = (list) A comma separated list of indices to close 157$params['timeout'] = (time) Explicit operation timeout 158$params['master_timeout'] = (time) Specify timeout for connection to master 159$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 160$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 161$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 162$params['wait_for_active_shards'] = (string) Sets the number of active shards to wait for before the operation returns. Set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`. 163*/ 164---- 165**** 166 167 168 169[[Elasticsearch_Namespaces_IndicesNamespacecreate_create]] 170.`create(array $params = [])` 171**** 172[source,php] 173---- 174/* 175$params['index'] = (string) The name of the index 176$params['include_type_name'] = (boolean) Whether a type should be expected in the body of the mappings. 177*/ 178---- 179**** 180 181 182 183[[Elasticsearch_Namespaces_IndicesNamespacecreateDataStream_createDataStream]] 184.`createDataStream(array $params = [])` 185**** 186[source,php] 187---- 188/* 189$params['name'] = (string) The name of the data stream 190*/ 191---- 192**** 193 194 195 196[[Elasticsearch_Namespaces_IndicesNamespacedataStreamsStats_dataStreamsStats]] 197.`dataStreamsStats(array $params = [])` 198**** 199[source,php] 200---- 201/* 202$params['name'] = (list) A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams 203*/ 204---- 205**** 206 207 208 209[[Elasticsearch_Namespaces_IndicesNamespacedelete_delete]] 210.`delete(array $params = [])` 211**** 212[source,php] 213---- 214/* 215$params['index'] = (list) A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices 216$params['timeout'] = (time) Explicit operation timeout 217$params['master_timeout'] = (time) Specify timeout for connection to master 218$params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false) 219$params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false) 220$params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) 221*/ 222---- 223**** 224 225 226 227[[Elasticsearch_Namespaces_IndicesNamespacedeleteAlias_deleteAlias]] 228.`deleteAlias(array $params = [])` 229**** 230[source,php] 231---- 232/* 233$params['index'] = (list) A comma-separated list of index names (supports wildcards); use `_all` for all indices (Required) 234$params['name'] = (list) A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. (Required) 235$params['timeout'] = (time) Explicit timestamp for the document 236$params['master_timeout'] = (time) Specify timeout for connection to master 237*/ 238---- 239**** 240 241 242 243[[Elasticsearch_Namespaces_IndicesNamespacedeleteDataStream_deleteDataStream]] 244.`deleteDataStream(array $params = [])` 245**** 246[source,php] 247---- 248/* 249$params['name'] = (list) A comma-separated list of data streams to delete; use `*` to delete all data streams 250$params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) 251*/ 252---- 253**** 254 255 256 257[[Elasticsearch_Namespaces_IndicesNamespacedeleteIndexTemplate_deleteIndexTemplate]] 258.`deleteIndexTemplate(array $params = [])` 259**** 260[source,php] 261---- 262/* 263$params['name'] = (string) The name of the template 264$params['timeout'] = (time) Explicit operation timeout 265$params['master_timeout'] = (time) Specify timeout for connection to master 266*/ 267---- 268**** 269 270 271 272[[Elasticsearch_Namespaces_IndicesNamespacedeleteTemplate_deleteTemplate]] 273.`deleteTemplate(array $params = [])` 274**** 275[source,php] 276---- 277/* 278$params['name'] = (string) The name of the template 279$params['timeout'] = (time) Explicit operation timeout 280$params['master_timeout'] = (time) Specify timeout for connection to master 281*/ 282---- 283**** 284 285 286 287[[Elasticsearch_Namespaces_IndicesNamespaceexists_exists]] 288.`exists(array $params = [])` 289**** 290[source,php] 291---- 292/* 293$params['index'] = (list) A comma-separated list of index names 294$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 295$params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false) 296$params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false) 297$params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) 298$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 299$params['include_defaults'] = (boolean) Whether to return all default setting for each of the indices. (Default = false) 300*/ 301---- 302**** 303 304 305 306[[Elasticsearch_Namespaces_IndicesNamespaceexistsAlias_existsAlias]] 307.`existsAlias(array $params = [])` 308**** 309[source,php] 310---- 311/* 312$params['name'] = (list) A comma-separated list of alias names to return (Required) 313$params['index'] = (list) A comma-separated list of index names to filter aliases 314$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 315$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 316$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) 317$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 318*/ 319---- 320**** 321 322 323 324[[Elasticsearch_Namespaces_IndicesNamespaceexistsIndexTemplate_existsIndexTemplate]] 325.`existsIndexTemplate(array $params = [])` 326**** 327[source,php] 328---- 329/* 330$params['name'] = (string) The name of the template 331$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 332$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 333$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 334*/ 335---- 336**** 337 338 339 340[[Elasticsearch_Namespaces_IndicesNamespaceexistsTemplate_existsTemplate]] 341.`existsTemplate(array $params = [])` 342**** 343[source,php] 344---- 345/* 346$params['name'] = (list) The comma separated names of the index templates 347$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 348$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 349$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 350*/ 351---- 352**** 353 354 355 356[[Elasticsearch_Namespaces_IndicesNamespaceexistsType_existsType]] 357.`existsType(array $params = [])` 358**** 359[source,php] 360---- 361/* 362$params['index'] = (list) A comma-separated list of index names; use `_all` to check the types across all indices 363$params['type'] = DEPRECATED (list) A comma-separated list of document types to check 364$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 365$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 366$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 367$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 368*/ 369---- 370**** 371 372 373 374[[Elasticsearch_Namespaces_IndicesNamespaceflush_flush]] 375.`flush(array $params = [])` 376**** 377[source,php] 378---- 379/* 380$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices 381$params['force'] = (boolean) Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) 382$params['wait_if_ongoing'] = (boolean) If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running. 383*/ 384---- 385**** 386 387 388 389[[Elasticsearch_Namespaces_IndicesNamespaceflushSynced_flushSynced]] 390.`flushSynced(array $params = [])` 391**** 392[source,php] 393---- 394/* 395$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices 396$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 397$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 398$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open) 399*/ 400---- 401**** 402 403 404 405[[Elasticsearch_Namespaces_IndicesNamespaceforcemerge_forcemerge]] 406.`forcemerge(array $params = [])` 407**** 408[source,php] 409---- 410/* 411$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 412$params['flush'] = (boolean) Specify whether the index should be flushed after performing the operation (default: true) 413$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 414$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 415$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 416$params['max_num_segments'] = (number) The number of segments the index should be merged into (default: dynamic) 417$params['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents 418*/ 419---- 420**** 421 422 423 424[[Elasticsearch_Namespaces_IndicesNamespacefreeze_freeze]] 425.`freeze(array $params = [])` 426**** 427[source,php] 428---- 429/* 430$params['index'] = (string) The name of the index to freeze 431$params['timeout'] = (time) Explicit operation timeout 432$params['master_timeout'] = (time) Specify timeout for connection to master 433$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 434$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 435$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = closed) 436$params['wait_for_active_shards'] = (string) Sets the number of active shards to wait for before the operation returns. 437*/ 438---- 439**** 440 441 442 443[[Elasticsearch_Namespaces_IndicesNamespaceget_get]] 444.`get(array $params = [])` 445**** 446[source,php] 447---- 448/* 449$params['index'] = (list) A comma-separated list of index names 450$params['include_type_name'] = (boolean) Whether to add the type name to the response (default: false) 451$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 452$params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false) 453$params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false) 454$params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) 455$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 456$params['include_defaults'] = (boolean) Whether to return all default setting for each of the indices. (Default = false) 457$params['master_timeout'] = (time) Specify timeout for connection to master 458*/ 459---- 460**** 461 462 463 464[[Elasticsearch_Namespaces_IndicesNamespacegetAlias_getAlias]] 465.`getAlias(array $params = [])` 466**** 467[source,php] 468---- 469/* 470$params['name'] = (list) A comma-separated list of alias names to return 471$params['index'] = (list) A comma-separated list of index names to filter aliases 472$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 473$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 474$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) 475$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 476*/ 477---- 478**** 479 480 481 482[[Elasticsearch_Namespaces_IndicesNamespacegetDataStream_getDataStream]] 483.`getDataStream(array $params = [])` 484**** 485[source,php] 486---- 487/* 488$params['name'] = (list) A comma-separated list of data streams to get; use `*` to get all data streams 489$params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) 490*/ 491---- 492**** 493 494 495 496[[Elasticsearch_Namespaces_IndicesNamespacegetFieldMapping_getFieldMapping]] 497.`getFieldMapping(array $params = [])` 498**** 499[source,php] 500---- 501/* 502$params['fields'] = (list) A comma-separated list of fields (Required) 503$params['index'] = (list) A comma-separated list of index names 504$params['type'] = DEPRECATED (list) A comma-separated list of document types 505$params['include_type_name'] = (boolean) Whether a type should be returned in the body of the mappings. 506*/ 507---- 508**** 509 510 511 512[[Elasticsearch_Namespaces_IndicesNamespacegetIndexTemplate_getIndexTemplate]] 513.`getIndexTemplate(array $params = [])` 514**** 515[source,php] 516---- 517/* 518$params['name'] = (list) The comma separated names of the index templates 519$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 520$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 521$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 522*/ 523---- 524**** 525 526 527 528[[Elasticsearch_Namespaces_IndicesNamespacegetMapping_getMapping]] 529.`getMapping(array $params = [])` 530**** 531[source,php] 532---- 533/* 534$params['index'] = (list) A comma-separated list of index names 535$params['type'] = DEPRECATED (list) A comma-separated list of document types 536$params['include_type_name'] = (boolean) Whether to add the type name to the response (default: false) 537$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 538$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 539$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 540$params['master_timeout'] = (time) Specify timeout for connection to master 541$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 542*/ 543---- 544**** 545 546 547 548[[Elasticsearch_Namespaces_IndicesNamespacegetSettings_getSettings]] 549.`getSettings(array $params = [])` 550**** 551[source,php] 552---- 553/* 554$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 555$params['name'] = (list) The name of the settings that should be included 556$params['master_timeout'] = (time) Specify timeout for connection to master 557$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 558$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 559$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) 560$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 561$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 562$params['include_defaults'] = (boolean) Whether to return all default setting for each of the indices. (Default = false) 563*/ 564---- 565**** 566 567 568 569[[Elasticsearch_Namespaces_IndicesNamespacegetTemplate_getTemplate]] 570.`getTemplate(array $params = [])` 571**** 572[source,php] 573---- 574/* 575$params['name'] = (list) The comma separated names of the index templates 576$params['include_type_name'] = (boolean) Whether a type should be returned in the body of the mappings. 577*/ 578---- 579**** 580 581 582 583[[Elasticsearch_Namespaces_IndicesNamespacegetUpgrade_getUpgrade]] 584.`getUpgrade(array $params = [])` 585**** 586[source,php] 587---- 588/* 589$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 590$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 591$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 592$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 593*/ 594---- 595**** 596 597 598 599[[Elasticsearch_Namespaces_IndicesNamespacemigrateToDataStream_migrateToDataStream]] 600.`migrateToDataStream(array $params = [])` 601**** 602[source,php] 603---- 604/* 605$params['name'] = (string) The name of the alias to migrate 606*/ 607---- 608**** 609 610 611 612[[Elasticsearch_Namespaces_IndicesNamespaceopen_open]] 613.`open(array $params = [])` 614**** 615[source,php] 616---- 617/* 618$params['index'] = (list) A comma separated list of indices to open 619$params['timeout'] = (time) Explicit operation timeout 620$params['master_timeout'] = (time) Specify timeout for connection to master 621$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 622$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 623$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = closed) 624$params['wait_for_active_shards'] = (string) Sets the number of active shards to wait for before the operation returns. 625*/ 626---- 627**** 628 629 630 631[[Elasticsearch_Namespaces_IndicesNamespacepromoteDataStream_promoteDataStream]] 632.`promoteDataStream(array $params = [])` 633**** 634[source,php] 635---- 636/* 637$params['name'] = (string) The name of the data stream 638*/ 639---- 640**** 641 642 643 644[[Elasticsearch_Namespaces_IndicesNamespaceputAlias_putAlias]] 645.`putAlias(array $params = [])` 646**** 647[source,php] 648---- 649/* 650$params['index'] = (list) A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. (Required) 651$params['name'] = (string) The name of the alias to be created or updated (Required) 652$params['timeout'] = (time) Explicit timestamp for the document 653$params['master_timeout'] = (time) Specify timeout for connection to master 654$params['body'] = (array) The settings for the alias, such as `routing` or `filter` 655*/ 656---- 657**** 658 659 660 661[[Elasticsearch_Namespaces_IndicesNamespaceputIndexTemplate_putIndexTemplate]] 662.`putIndexTemplate(array $params = [])` 663**** 664[source,php] 665---- 666/* 667$params['name'] = (string) The name of the template 668$params['create'] = (boolean) Whether the index template should only be added if new or can also replace an existing one (Default = false) 669$params['cause'] = (string) User defined reason for creating/updating the index template (Default = ) 670$params['master_timeout'] = (time) Specify timeout for connection to master 671$params['body'] = (array) The template definition (Required) 672*/ 673---- 674**** 675 676 677 678[[Elasticsearch_Namespaces_IndicesNamespaceputMapping_putMapping]] 679.`putMapping(array $params = [])` 680**** 681[source,php] 682---- 683/* 684$params['index'] = (list) A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. 685*/ 686---- 687**** 688 689 690 691[[Elasticsearch_Namespaces_IndicesNamespaceputSettings_putSettings]] 692.`putSettings(array $params = [])` 693**** 694[source,php] 695---- 696/* 697$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 698$params['master_timeout'] = (time) Specify timeout for connection to master 699$params['timeout'] = (time) Explicit operation timeout 700$params['preserve_existing'] = (boolean) Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` 701$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 702$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 703$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 704$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 705$params['body'] = (array) The index settings to be updated (Required) 706*/ 707---- 708**** 709 710 711 712[[Elasticsearch_Namespaces_IndicesNamespaceputTemplate_putTemplate]] 713.`putTemplate(array $params = [])` 714**** 715[source,php] 716---- 717/* 718$params['name'] = (string) The name of the template 719$params['include_type_name'] = (boolean) Whether a type should be returned in the body of the mappings. 720*/ 721---- 722**** 723 724 725 726[[Elasticsearch_Namespaces_IndicesNamespacerecovery_recovery]] 727.`recovery(array $params = [])` 728**** 729[source,php] 730---- 731/* 732$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 733$params['detailed'] = (boolean) Whether to display detailed information about shard recovery (Default = false) 734$params['active_only'] = (boolean) Display only those recoveries that are currently on-going (Default = false) 735*/ 736---- 737**** 738 739 740 741[[Elasticsearch_Namespaces_IndicesNamespacerefresh_refresh]] 742.`refresh(array $params = [])` 743**** 744[source,php] 745---- 746/* 747$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 748$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 749$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 750$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 751*/ 752---- 753**** 754 755 756 757[[Elasticsearch_Namespaces_IndicesNamespacereloadSearchAnalyzers_reloadSearchAnalyzers]] 758.`reloadSearchAnalyzers(array $params = [])` 759**** 760[source,php] 761---- 762/* 763$params['index'] = (list) A comma-separated list of index names to reload analyzers for 764$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 765$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 766$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 767*/ 768---- 769**** 770 771 772 773[[Elasticsearch_Namespaces_IndicesNamespaceresolveIndex_resolveIndex]] 774.`resolveIndex(array $params = [])` 775*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 776**** 777[source,php] 778---- 779/* 780$params['name'] = (list) A comma-separated list of names or wildcard expressions 781$params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) 782*/ 783---- 784**** 785 786 787 788[[Elasticsearch_Namespaces_IndicesNamespacerollover_rollover]] 789.`rollover(array $params = [])` 790**** 791[source,php] 792---- 793/* 794$params['alias'] = (string) The name of the alias to rollover (Required) 795$params['new_index'] = (string) The name of the rollover index 796$params['include_type_name'] = (boolean) Whether a type should be included in the body of the mappings. 797*/ 798---- 799**** 800 801 802 803[[Elasticsearch_Namespaces_IndicesNamespacesegments_segments]] 804.`segments(array $params = [])` 805**** 806[source,php] 807---- 808/* 809$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 810$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 811$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 812$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 813$params['verbose'] = (boolean) Includes detailed memory usage by Lucene. (Default = false) 814*/ 815---- 816**** 817 818 819 820[[Elasticsearch_Namespaces_IndicesNamespaceshardStores_shardStores]] 821.`shardStores(array $params = [])` 822**** 823[source,php] 824---- 825/* 826$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 827$params['status'] = (list) A comma-separated list of statuses used to filter on shards to get store information for (Options = green,yellow,red,all) 828$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 829$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 830$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 831*/ 832---- 833**** 834 835 836 837[[Elasticsearch_Namespaces_IndicesNamespaceshrink_shrink]] 838.`shrink(array $params = [])` 839**** 840[source,php] 841---- 842/* 843$params['index'] = (string) The name of the source index to shrink 844$params['target'] = (string) The name of the target index to shrink into 845$params['copy_settings'] = (boolean) whether or not to copy settings from the source index (defaults to false) 846$params['timeout'] = (time) Explicit operation timeout 847$params['master_timeout'] = (time) Specify timeout for connection to master 848$params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the shrunken index before the operation returns. 849*/ 850---- 851**** 852 853 854 855[[Elasticsearch_Namespaces_IndicesNamespacesimulateIndexTemplate_simulateIndexTemplate]] 856.`simulateIndexTemplate(array $params = [])` 857**** 858[source,php] 859---- 860/* 861$params['name'] = (string) The name of the index (it must be a concrete index name) 862$params['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 (Default = false) 863$params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes (Default = ) 864$params['master_timeout'] = (time) Specify timeout for connection to master 865$params['body'] = (array) New index template definition, which will be included in the simulation, as if it already exists in the system 866*/ 867---- 868**** 869 870 871 872[[Elasticsearch_Namespaces_IndicesNamespacesimulateTemplate_simulateTemplate]] 873.`simulateTemplate(array $params = [])` 874**** 875[source,php] 876---- 877/* 878$params['name'] = (string) The name of the index template 879$params['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 (Default = false) 880$params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes (Default = ) 881$params['master_timeout'] = (time) Specify timeout for connection to master 882$params['body'] = (array) New index template definition to be simulated, if no index template name is specified 883*/ 884---- 885**** 886 887 888 889[[Elasticsearch_Namespaces_IndicesNamespacesplit_split]] 890.`split(array $params = [])` 891**** 892[source,php] 893---- 894/* 895$params['index'] = (string) The name of the source index to split 896$params['target'] = (string) The name of the target index to split into 897$params['copy_settings'] = (boolean) whether or not to copy settings from the source index (defaults to false) 898$params['timeout'] = (time) Explicit operation timeout 899$params['master_timeout'] = (time) Specify timeout for connection to master 900$params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the shrunken index before the operation returns. 901*/ 902---- 903**** 904 905 906 907[[Elasticsearch_Namespaces_IndicesNamespacestats_stats]] 908.`stats(array $params = [])` 909**** 910[source,php] 911---- 912/* 913$params['metric'] = (list) Limit the information returned the specific metrics. 914*/ 915---- 916**** 917 918 919 920[[Elasticsearch_Namespaces_IndicesNamespaceunfreeze_unfreeze]] 921.`unfreeze(array $params = [])` 922**** 923[source,php] 924---- 925/* 926$params['index'] = (string) The name of the index to unfreeze 927$params['timeout'] = (time) Explicit operation timeout 928$params['master_timeout'] = (time) Specify timeout for connection to master 929$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 930$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 931$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = closed) 932$params['wait_for_active_shards'] = (string) Sets the number of active shards to wait for before the operation returns. 933*/ 934---- 935**** 936 937 938 939[[Elasticsearch_Namespaces_IndicesNamespaceupdateAliases_updateAliases]] 940.`updateAliases(array $params = [])` 941**** 942[source,php] 943---- 944/* 945$params['timeout'] = (time) Request timeout 946$params['master_timeout'] = (time) Specify timeout for connection to master 947$params['body'] = (array) The definition of `actions` to perform (Required) 948*/ 949---- 950**** 951 952 953 954[[Elasticsearch_Namespaces_IndicesNamespaceupgrade_upgrade]] 955.`upgrade(array $params = [])` 956**** 957[source,php] 958---- 959/* 960$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 961$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 962$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 963$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 964$params['wait_for_completion'] = (boolean) Specify whether the request should block until the all segments are upgraded (default: false) 965$params['only_ancient_segments'] = (boolean) If true, only ancient (an older Lucene major release) segments will be upgraded 966*/ 967---- 968**** 969 970 971 972[[Elasticsearch_Namespaces_IndicesNamespacevalidateQuery_validateQuery]] 973.`validateQuery(array $params = [])` 974**** 975[source,php] 976---- 977/* 978$params['index'] = (list) A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices 979$params['type'] = DEPRECATED (list) A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types 980$params['explain'] = (boolean) Return detailed information about the error 981$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 982$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) 983$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) 984$params['q'] = (string) Query in the Lucene query string syntax 985$params['analyzer'] = (string) The analyzer to use for the query string 986$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false) 987$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR) 988$params['df'] = (string) The field to use as default where no field prefix is given in the query string 989$params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored 990$params['rewrite'] = (boolean) Provide a more detailed explanation showing the actual Lucene query that will be executed. 991*/ 992---- 993**** 994 995 996 997[[Elasticsearch_Namespaces_IndicesNamespacegetAliases_getAliases]] 998.`getAliases(array $params = [])` 999**** 1000[source,php] 1001---- 1002/* 1003Alias function to getAlias() 1004*/ 1005---- 1006**** 1007 1008 1009