1 2 3[[Elasticsearch_Client]] 4=== Elasticsearch\Client 5 6 7 8Class Client 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_Clientbulk_bulk,`bulk()`>> 22* <<Elasticsearch_ClientclearScroll_clearScroll,`clearScroll()`>> 23* <<Elasticsearch_ClientclosePointInTime_closePointInTime,`closePointInTime()`>> 24* <<Elasticsearch_Clientcount_count,`count()`>> 25* <<Elasticsearch_Clientcreate_create,`create()`>> 26* <<Elasticsearch_Clientdelete_delete,`delete()`>> 27* <<Elasticsearch_ClientdeleteByQuery_deleteByQuery,`deleteByQuery()`>> 28* <<Elasticsearch_ClientdeleteByQueryRethrottle_deleteByQueryRethrottle,`deleteByQueryRethrottle()`>> 29* <<Elasticsearch_ClientdeleteScript_deleteScript,`deleteScript()`>> 30* <<Elasticsearch_Clientexists_exists,`exists()`>> 31* <<Elasticsearch_ClientexistsSource_existsSource,`existsSource()`>> 32* <<Elasticsearch_Clientexplain_explain,`explain()`>> 33* <<Elasticsearch_ClientfieldCaps_fieldCaps,`fieldCaps()`>> 34* <<Elasticsearch_Clientget_get,`get()`>> 35* <<Elasticsearch_ClientgetScript_getScript,`getScript()`>> 36* <<Elasticsearch_ClientgetScriptContext_getScriptContext,`getScriptContext()`>> 37* <<Elasticsearch_ClientgetScriptLanguages_getScriptLanguages,`getScriptLanguages()`>> 38* <<Elasticsearch_ClientgetSource_getSource,`getSource()`>> 39* <<Elasticsearch_Clientindex_index,`index()`>> 40* <<Elasticsearch_Clientinfo_info,`info()`>> 41* <<Elasticsearch_Clientmget_mget,`mget()`>> 42* <<Elasticsearch_Clientmsearch_msearch,`msearch()`>> 43* <<Elasticsearch_ClientmsearchTemplate_msearchTemplate,`msearchTemplate()`>> 44* <<Elasticsearch_Clientmtermvectors_mtermvectors,`mtermvectors()`>> 45* <<Elasticsearch_ClientopenPointInTime_openPointInTime,`openPointInTime()`>> 46* <<Elasticsearch_Clientping_ping,`ping()`>> 47* <<Elasticsearch_ClientputScript_putScript,`putScript()`>> 48* <<Elasticsearch_ClientrankEval_rankEval,`rankEval()`>> 49* <<Elasticsearch_Clientreindex_reindex,`reindex()`>> 50* <<Elasticsearch_ClientreindexRethrottle_reindexRethrottle,`reindexRethrottle()`>> 51* <<Elasticsearch_ClientrenderSearchTemplate_renderSearchTemplate,`renderSearchTemplate()`>> 52* <<Elasticsearch_ClientscriptsPainlessExecute_scriptsPainlessExecute,`scriptsPainlessExecute()`>> 53* <<Elasticsearch_Clientscroll_scroll,`scroll()`>> 54* <<Elasticsearch_Clientsearch_search,`search()`>> 55* <<Elasticsearch_ClientsearchShards_searchShards,`searchShards()`>> 56* <<Elasticsearch_ClientsearchTemplate_searchTemplate,`searchTemplate()`>> 57* <<Elasticsearch_Clienttermvectors_termvectors,`termvectors()`>> 58* <<Elasticsearch_Clientupdate_update,`update()`>> 59* <<Elasticsearch_ClientupdateByQuery_updateByQuery,`updateByQuery()`>> 60* <<Elasticsearch_ClientupdateByQueryRethrottle_updateByQueryRethrottle,`updateByQueryRethrottle()`>> 61* <<Elasticsearch_ClientasyncSearch_asyncSearch,`asyncSearch()`>> 62* <<Elasticsearch_Clientautoscaling_autoscaling,`autoscaling()`>> 63* <<Elasticsearch_Clientcat_cat,`cat()`>> 64* <<Elasticsearch_Clientccr_ccr,`ccr()`>> 65* <<Elasticsearch_Clientcluster_cluster,`cluster()`>> 66* <<Elasticsearch_ClientdanglingIndices_danglingIndices,`danglingIndices()`>> 67* <<Elasticsearch_ClientdataFrameTransformDeprecated_dataFrameTransformDeprecated,`dataFrameTransformDeprecated()`>> 68* <<Elasticsearch_Clientenrich_enrich,`enrich()`>> 69* <<Elasticsearch_Clienteql_eql,`eql()`>> 70* <<Elasticsearch_Clientfeatures_features,`features()`>> 71* <<Elasticsearch_Clientgraph_graph,`graph()`>> 72* <<Elasticsearch_Clientilm_ilm,`ilm()`>> 73* <<Elasticsearch_Clientindices_indices,`indices()`>> 74* <<Elasticsearch_Clientingest_ingest,`ingest()`>> 75* <<Elasticsearch_Clientlicense_license,`license()`>> 76* <<Elasticsearch_Clientlogstash_logstash,`logstash()`>> 77* <<Elasticsearch_Clientmigration_migration,`migration()`>> 78* <<Elasticsearch_Clientml_ml,`ml()`>> 79* <<Elasticsearch_Clientmonitoring_monitoring,`monitoring()`>> 80* <<Elasticsearch_Clientnodes_nodes,`nodes()`>> 81* <<Elasticsearch_Clientrollup_rollup,`rollup()`>> 82* <<Elasticsearch_ClientsearchableSnapshots_searchableSnapshots,`searchableSnapshots()`>> 83* <<Elasticsearch_Clientsecurity_security,`security()`>> 84* <<Elasticsearch_Clientslm_slm,`slm()`>> 85* <<Elasticsearch_Clientsnapshot_snapshot,`snapshot()`>> 86* <<Elasticsearch_Clientsql_sql,`sql()`>> 87* <<Elasticsearch_Clientssl_ssl,`ssl()`>> 88* <<Elasticsearch_Clienttasks_tasks,`tasks()`>> 89* <<Elasticsearch_ClienttextStructure_textStructure,`textStructure()`>> 90* <<Elasticsearch_Clienttransform_transform,`transform()`>> 91* <<Elasticsearch_Clientwatcher_watcher,`watcher()`>> 92* <<Elasticsearch_Clientxpack_xpack,`xpack()`>> 93* <<Elasticsearch_Client-call-_call,`__call()`>> 94* <<Elasticsearch_ClientextractArgument_extractArgument,`extractArgument()`>> 95 96 97 98 99[[Elasticsearch_Clientbulk_bulk]] 100.`bulk(array $params = [])` 101**** 102[source,php] 103---- 104/* 105$params['index'] = (string) Default index for items which don't provide one 106$params['type'] = DEPRECATED (string) Default document type for items which don't provide one 107$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) 108$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for) 109$params['routing'] = (string) Specific routing value 110$params['timeout'] = (time) Explicit operation timeout 111$params['_source'] = (list) True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request 112$params['_source_excludes'] = (list) Default list of fields to exclude from the returned _source field, can be overridden on each sub-request 113$params['_source_includes'] = (list) Default list of fields to extract and return from the _source field, can be overridden on each sub-request 114$params['pipeline'] = (string) The pipeline id to preprocess incoming documents with 115$params['require_alias'] = (boolean) Sets require_alias for all incoming documents. Defaults to unset (false) 116$params['body'] = (array) The operation definition and data (action-data pairs), separated by newlines (Required) 117*/ 118---- 119**** 120 121 122 123[[Elasticsearch_ClientclearScroll_clearScroll]] 124.`clearScroll(array $params = [])` 125**** 126[source,php] 127---- 128/* 129$params['scroll_id'] = DEPRECATED (list) A comma-separated list of scroll IDs to clear 130$params['body'] = (array) A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter 131*/ 132---- 133**** 134 135 136 137[[Elasticsearch_ClientclosePointInTime_closePointInTime]] 138.`closePointInTime(array $params = [])` 139**** 140[source,php] 141---- 142/* 143$params['body'] = (array) a point-in-time id to close 144*/ 145---- 146**** 147 148 149 150[[Elasticsearch_Clientcount_count]] 151.`count(array $params = [])` 152**** 153[source,php] 154---- 155/* 156$params['index'] = (list) A comma-separated list of indices to restrict the results 157$params['type'] = DEPRECATED (list) A comma-separated list of types to restrict the results 158$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 159$params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled 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['min_score'] = (number) Include only documents with a specific `_score` value in the result 163$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 164$params['routing'] = (list) A comma-separated list of specific routing values 165$params['q'] = (string) Query in the Lucene query string syntax 166$params['analyzer'] = (string) The analyzer to use for the query string 167$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false) 168$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR) 169$params['df'] = (string) The field to use as default where no field prefix is given in the query string 170$params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored 171$params['terminate_after'] = (number) The maximum count for each shard, upon reaching which the query execution will terminate early 172$params['body'] = (array) A query to restrict the results specified with the Query DSL (optional) 173*/ 174---- 175**** 176 177 178 179[[Elasticsearch_Clientcreate_create]] 180.`create(array $params = [])` 181**** 182[source,php] 183---- 184/* 185$params['id'] = (string) Document ID (Required) 186$params['index'] = (string) The name of the index (Required) 187$params['type'] = DEPRECATED (string) The type of the document 188$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) 189$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for) 190$params['routing'] = (string) Specific routing value 191$params['timeout'] = (time) Explicit operation timeout 192$params['version'] = (number) Explicit version number for concurrency control 193$params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte) 194$params['pipeline'] = (string) The pipeline id to preprocess incoming documents with 195$params['body'] = (array) The document (Required) 196*/ 197---- 198**** 199 200 201 202[[Elasticsearch_Clientdelete_delete]] 203.`delete(array $params = [])` 204**** 205[source,php] 206---- 207/* 208$params['id'] = (string) The document ID (Required) 209$params['index'] = (string) The name of the index (Required) 210$params['type'] = DEPRECATED (string) The type of the document 211$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) 212$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for) 213$params['routing'] = (string) Specific routing value 214$params['timeout'] = (time) Explicit operation timeout 215$params['if_seq_no'] = (number) only perform the delete operation if the last operation that has changed the document has the specified sequence number 216$params['if_primary_term'] = (number) only perform the delete operation if the last operation that has changed the document has the specified primary term 217$params['version'] = (number) Explicit version number for concurrency control 218$params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force) 219*/ 220---- 221**** 222 223 224 225[[Elasticsearch_ClientdeleteByQuery_deleteByQuery]] 226.`deleteByQuery(array $params = [])` 227**** 228[source,php] 229---- 230/* 231$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required) 232$params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types 233$params['analyzer'] = (string) The analyzer to use for the query string 234$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false) 235$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR) 236$params['df'] = (string) The field to use as default where no field prefix is given in the query string 237$params['from'] = (number) Starting offset (default: 0) 238$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 239$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) 240$params['conflicts'] = (enum) What to do when the delete by query hits version conflicts? (Options = abort,proceed) (Default = abort) 241$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) 242$params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored 243$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 244$params['q'] = (string) Query in the Lucene query string syntax 245$params['routing'] = (list) A comma-separated list of specific routing values 246$params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search 247$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch) 248$params['search_timeout'] = (time) Explicit timeout for each search request. Defaults to no timeout. 249*/ 250---- 251**** 252 253 254 255[[Elasticsearch_ClientdeleteByQueryRethrottle_deleteByQueryRethrottle]] 256.`deleteByQueryRethrottle(array $params = [])` 257**** 258[source,php] 259---- 260/* 261$params['task_id'] = (string) The task id to rethrottle 262$params['requests_per_second'] = (number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required) 263*/ 264---- 265**** 266 267 268 269[[Elasticsearch_ClientdeleteScript_deleteScript]] 270.`deleteScript(array $params = [])` 271**** 272[source,php] 273---- 274/* 275$params['id'] = (string) Script ID 276$params['timeout'] = (time) Explicit operation timeout 277$params['master_timeout'] = (time) Specify timeout for connection to master 278*/ 279---- 280**** 281 282 283 284[[Elasticsearch_Clientexists_exists]] 285.`exists(array $params = [])` 286**** 287[source,php] 288---- 289/* 290$params['id'] = (string) The document ID (Required) 291$params['index'] = (string) The name of the index (Required) 292$params['type'] = DEPRECATED (string) The type of the document (use `_all` to fetch the first document matching the ID across all types) 293$params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response 294$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 295$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode 296$params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation 297$params['routing'] = (string) Specific routing value 298$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return 299$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field 300$params['_source_includes'] = (list) A list of fields to extract and return from the _source field 301$params['version'] = (number) Explicit version number for concurrency control 302$params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force) 303*/ 304---- 305**** 306 307 308 309[[Elasticsearch_ClientexistsSource_existsSource]] 310.`existsSource(array $params = [])` 311**** 312[source,php] 313---- 314/* 315$params['id'] = (string) The document ID (Required) 316$params['index'] = (string) The name of the index (Required) 317$params['type'] = DEPRECATED (string) The type of the document; deprecated and optional starting with 7.0 318$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 319$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode 320$params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation 321$params['routing'] = (string) Specific routing value 322$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return 323$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field 324$params['_source_includes'] = (list) A list of fields to extract and return from the _source field 325$params['version'] = (number) Explicit version number for concurrency control 326$params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force) 327*/ 328---- 329**** 330 331 332 333[[Elasticsearch_Clientexplain_explain]] 334.`explain(array $params = [])` 335**** 336[source,php] 337---- 338/* 339$params['id'] = (string) The document ID (Required) 340$params['index'] = (string) The name of the index (Required) 341$params['type'] = DEPRECATED (string) The type of the document 342$params['analyze_wildcard'] = (boolean) Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) 343$params['analyzer'] = (string) The analyzer for the query string query 344$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR) 345$params['df'] = (string) The default field for query string query (default: _all) 346$params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response 347$params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored 348$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 349$params['q'] = (string) Query in the Lucene query string syntax 350$params['routing'] = (string) Specific routing value 351$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return 352$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field 353$params['_source_includes'] = (list) A list of fields to extract and return from the _source field 354$params['body'] = (array) The query definition using the Query DSL 355*/ 356---- 357**** 358 359 360 361[[Elasticsearch_ClientfieldCaps_fieldCaps]] 362.`fieldCaps(array $params = [])` 363**** 364[source,php] 365---- 366/* 367$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 368$params['fields'] = (list) A comma-separated list of field names 369$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 370$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) 371$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) 372$params['include_unmapped'] = (boolean) Indicates whether unmapped fields should be included in the response. (Default = false) 373$params['body'] = (array) An index filter specified with the Query DSL 374*/ 375---- 376**** 377 378 379 380[[Elasticsearch_Clientget_get]] 381.`get(array $params = [])` 382**** 383[source,php] 384---- 385/* 386$params['id'] = (string) The document ID (Required) 387$params['index'] = (string) The name of the index (Required) 388$params['type'] = DEPRECATED (string) The type of the document (use `_all` to fetch the first document matching the ID across all types) 389$params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response 390$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 391$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode 392$params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation 393$params['routing'] = (string) Specific routing value 394$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return 395$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field 396$params['_source_includes'] = (list) A list of fields to extract and return from the _source field 397$params['version'] = (number) Explicit version number for concurrency control 398$params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force) 399*/ 400---- 401**** 402 403 404 405[[Elasticsearch_ClientgetScript_getScript]] 406.`getScript(array $params = [])` 407**** 408[source,php] 409---- 410/* 411$params['id'] = (string) Script ID 412$params['master_timeout'] = (time) Specify timeout for connection to master 413*/ 414---- 415**** 416 417 418 419[[Elasticsearch_ClientgetScriptContext_getScriptContext]] 420.`getScriptContext(array $params = [])` 421*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 422**** 423[source,php] 424---- 425/* 426*/ 427---- 428**** 429 430 431 432[[Elasticsearch_ClientgetScriptLanguages_getScriptLanguages]] 433.`getScriptLanguages(array $params = [])` 434*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 435**** 436[source,php] 437---- 438/* 439*/ 440---- 441**** 442 443 444 445[[Elasticsearch_ClientgetSource_getSource]] 446.`getSource(array $params = [])` 447**** 448[source,php] 449---- 450/* 451$params['id'] = (string) The document ID (Required) 452$params['index'] = (string) The name of the index (Required) 453$params['type'] = DEPRECATED (string) The type of the document; deprecated and optional starting with 7.0 454$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 455$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode 456$params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation 457$params['routing'] = (string) Specific routing value 458$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return 459$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field 460$params['_source_includes'] = (list) A list of fields to extract and return from the _source field 461$params['version'] = (number) Explicit version number for concurrency control 462$params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force) 463*/ 464---- 465**** 466 467 468 469[[Elasticsearch_Clientindex_index]] 470.`index(array $params = [])` 471**** 472[source,php] 473---- 474/* 475$params['id'] = (string) Document ID 476$params['index'] = (string) The name of the index (Required) 477$params['type'] = DEPRECATED (string) The type of the document 478$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) 479$params['op_type'] = (enum) Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (Options = index,create) 480$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for) 481$params['routing'] = (string) Specific routing value 482$params['timeout'] = (time) Explicit operation timeout 483$params['version'] = (number) Explicit version number for concurrency control 484$params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte) 485$params['if_seq_no'] = (number) only perform the index operation if the last operation that has changed the document has the specified sequence number 486$params['if_primary_term'] = (number) only perform the index operation if the last operation that has changed the document has the specified primary term 487$params['pipeline'] = (string) The pipeline id to preprocess incoming documents with 488$params['require_alias'] = (boolean) When true, requires destination to be an alias. Default is false 489$params['body'] = (array) The document (Required) 490*/ 491---- 492**** 493 494 495 496[[Elasticsearch_Clientinfo_info]] 497.`info(array $params = [])` 498**** 499[source,php] 500---- 501/* 502*/ 503---- 504**** 505 506 507 508[[Elasticsearch_Clientmget_mget]] 509.`mget(array $params = [])` 510**** 511[source,php] 512---- 513/* 514$params['index'] = (string) The name of the index 515$params['type'] = DEPRECATED (string) The type of the document 516$params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response 517$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 518$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode 519$params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation 520$params['routing'] = (string) Specific routing value 521$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return 522$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field 523$params['_source_includes'] = (list) A list of fields to extract and return from the _source field 524$params['body'] = (array) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. (Required) 525*/ 526---- 527**** 528 529 530 531[[Elasticsearch_Clientmsearch_msearch]] 532.`msearch(array $params = [])` 533**** 534[source,php] 535---- 536/* 537$params['index'] = (list) A comma-separated list of index names to use as default 538$params['type'] = DEPRECATED (list) A comma-separated list of document types to use as default 539$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch) 540$params['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute 541$params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response 542$params['pre_filter_shard_size'] = (number) A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. 543*/ 544---- 545**** 546 547 548 549[[Elasticsearch_ClientmsearchTemplate_msearchTemplate]] 550.`msearchTemplate(array $params = [])` 551**** 552[source,php] 553---- 554/* 555$params['index'] = (list) A comma-separated list of index names to use as default 556$params['type'] = DEPRECATED (list) A comma-separated list of document types to use as default 557$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch) 558$params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response 559$params['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute 560$params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false) 561$params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true) 562$params['body'] = (array) The request definitions (metadata-search request definition pairs), separated by newlines (Required) 563*/ 564---- 565**** 566 567 568 569[[Elasticsearch_Clientmtermvectors_mtermvectors]] 570.`mtermvectors(array $params = [])` 571**** 572[source,php] 573---- 574/* 575$params['index'] = (string) The index in which the document resides. 576*/ 577---- 578**** 579 580 581 582[[Elasticsearch_ClientopenPointInTime_openPointInTime]] 583.`openPointInTime(array $params = [])` 584**** 585[source,php] 586---- 587/* 588$params['index'] = (list) A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices 589$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 590$params['routing'] = (string) Specific routing value 591$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 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$params['keep_alive'] = (string) Specific the time to live for the point in time 594*/ 595---- 596**** 597 598 599 600[[Elasticsearch_Clientping_ping]] 601.`ping(array $params = [])` 602**** 603[source,php] 604---- 605/* 606*/ 607---- 608**** 609 610 611 612[[Elasticsearch_ClientputScript_putScript]] 613.`putScript(array $params = [])` 614**** 615[source,php] 616---- 617/* 618$params['id'] = (string) Script ID (Required) 619$params['context'] = (string) Script context 620$params['timeout'] = (time) Explicit operation timeout 621$params['master_timeout'] = (time) Specify timeout for connection to master 622$params['body'] = (array) The document (Required) 623*/ 624---- 625**** 626 627 628 629[[Elasticsearch_ClientrankEval_rankEval]] 630.`rankEval(array $params = [])` 631*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 632**** 633[source,php] 634---- 635/* 636$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices 637$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 638$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) 639$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) 640$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch) 641$params['body'] = (array) The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (Required) 642*/ 643---- 644**** 645 646 647 648[[Elasticsearch_Clientreindex_reindex]] 649.`reindex(array $params = [])` 650**** 651[source,php] 652---- 653/* 654$params['refresh'] = (boolean) Should the affected indexes be refreshed? 655$params['timeout'] = (time) Time each individual bulk request should wait for shards that are unavailable. (Default = 1m) 656$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) 657$params['wait_for_completion'] = (boolean) Should the request should block until the reindex is complete. (Default = true) 658$params['requests_per_second'] = (number) The throttle to set on this request in sub-requests per second. -1 means no throttle. (Default = 0) 659$params['scroll'] = (time) Control how long to keep the search context alive (Default = 5m) 660$params['slices'] = (number|string) The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. (Default = 1) 661$params['max_docs'] = (number) Maximum number of documents to process (default: all documents) 662$params['body'] = (array) The search definition using the Query DSL and the prototype for the index request. (Required) 663*/ 664---- 665**** 666 667 668 669[[Elasticsearch_ClientreindexRethrottle_reindexRethrottle]] 670.`reindexRethrottle(array $params = [])` 671**** 672[source,php] 673---- 674/* 675$params['task_id'] = (string) The task id to rethrottle 676$params['requests_per_second'] = (number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required) 677*/ 678---- 679**** 680 681 682 683[[Elasticsearch_ClientrenderSearchTemplate_renderSearchTemplate]] 684.`renderSearchTemplate(array $params = [])` 685**** 686[source,php] 687---- 688/* 689$params['id'] = (string) The id of the stored search template 690$params['body'] = (array) The search definition template and its params 691*/ 692---- 693**** 694 695 696 697[[Elasticsearch_ClientscriptsPainlessExecute_scriptsPainlessExecute]] 698.`scriptsPainlessExecute(array $params = [])` 699*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release 700**** 701[source,php] 702---- 703/* 704$params['body'] = (array) The script to execute 705*/ 706---- 707**** 708 709 710 711[[Elasticsearch_Clientscroll_scroll]] 712.`scroll(array $params = [])` 713**** 714[source,php] 715---- 716/* 717$params['scroll_id'] = DEPRECATED (string) The scroll ID 718$params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search 719$params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false) 720$params['body'] = (array) The scroll ID if not passed by URL or query parameter. 721*/ 722---- 723**** 724 725 726 727[[Elasticsearch_Clientsearch_search]] 728.`search(array $params = [])` 729**** 730[source,php] 731---- 732/* 733$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices 734$params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types 735$params['analyzer'] = (string) The analyzer to use for the query string 736$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false) 737$params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true) 738$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR) 739$params['df'] = (string) The field to use as default where no field prefix is given in the query string 740$params['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit 741$params['stored_fields'] = (list) A comma-separated list of stored fields to return as part of a hit 742$params['docvalue_fields'] = (list) A comma-separated list of fields to return as the docvalue representation of a field for each hit 743$params['from'] = (number) Starting offset (default: 0) 744$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 745$params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled 746$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) 747$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) 748$params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored 749$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 750$params['q'] = (string) Query in the Lucene query string syntax 751$params['routing'] = (list) A comma-separated list of specific routing values 752$params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search 753$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch) 754$params['size'] = (number) Number of hits to return (default: 10) 755$params['sort'] = (list) A comma-separated list of <field>:<direction> pairs 756$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return 757$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field 758$params['_source_includes'] = (list) A list of fields to extract and return from the _source field 759$params['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. 760*/ 761---- 762**** 763 764 765 766[[Elasticsearch_ClientsearchShards_searchShards]] 767.`searchShards(array $params = [])` 768**** 769[source,php] 770---- 771/* 772$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices 773$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 774$params['routing'] = (string) Specific routing value 775$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 776$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 777$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) 778$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) 779*/ 780---- 781**** 782 783 784 785[[Elasticsearch_ClientsearchTemplate_searchTemplate]] 786.`searchTemplate(array $params = [])` 787**** 788[source,php] 789---- 790/* 791$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices 792$params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types 793$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 794$params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled 795$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) 796$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) 797$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 798$params['routing'] = (list) A comma-separated list of specific routing values 799$params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search 800$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch) 801$params['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit 802$params['profile'] = (boolean) Specify whether to profile the query execution 803$params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response 804$params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false) 805$params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true) 806$params['body'] = (array) The search definition template and its params (Required) 807*/ 808---- 809**** 810 811 812 813[[Elasticsearch_Clienttermvectors_termvectors]] 814.`termvectors(array $params = [])` 815**** 816[source,php] 817---- 818/* 819$params['index'] = (string) The index in which the document resides. (Required) 820$params['id'] = (string) The id of the document, when not specified a doc param should be supplied. 821*/ 822---- 823**** 824 825 826 827[[Elasticsearch_Clientupdate_update]] 828.`update(array $params = [])` 829**** 830[source,php] 831---- 832/* 833$params['id'] = (string) Document ID (Required) 834$params['index'] = (string) The name of the index (Required) 835$params['type'] = DEPRECATED (string) The type of the document 836$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) 837$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return 838$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field 839$params['_source_includes'] = (list) A list of fields to extract and return from the _source field 840$params['lang'] = (string) The script language (default: painless) 841$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for) 842$params['retry_on_conflict'] = (number) Specify how many times should the operation be retried when a conflict occurs (default: 0) 843$params['routing'] = (string) Specific routing value 844$params['timeout'] = (time) Explicit operation timeout 845$params['if_seq_no'] = (number) only perform the update operation if the last operation that has changed the document has the specified sequence number 846$params['if_primary_term'] = (number) only perform the update operation if the last operation that has changed the document has the specified primary term 847$params['require_alias'] = (boolean) When true, requires destination is an alias. Default is false 848$params['body'] = (array) The request definition requires either `script` or partial `doc` (Required) 849*/ 850---- 851**** 852 853 854 855[[Elasticsearch_ClientupdateByQuery_updateByQuery]] 856.`updateByQuery(array $params = [])` 857**** 858[source,php] 859---- 860/* 861$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required) 862$params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types 863$params['analyzer'] = (string) The analyzer to use for the query string 864$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false) 865$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR) 866$params['df'] = (string) The field to use as default where no field prefix is given in the query string 867$params['from'] = (number) Starting offset (default: 0) 868$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 869$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) 870$params['conflicts'] = (enum) What to do when the update by query hits version conflicts? (Options = abort,proceed) (Default = abort) 871$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) 872$params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored 873$params['pipeline'] = (string) Ingest pipeline to set on index requests made by this action. (default: none) 874$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) 875$params['q'] = (string) Query in the Lucene query string syntax 876$params['routing'] = (list) A comma-separated list of specific routing values 877$params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search 878$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch) 879$params['search_timeout'] = (time) Explicit timeout for each search request. Defaults to no timeout. 880*/ 881---- 882**** 883 884 885 886[[Elasticsearch_ClientupdateByQueryRethrottle_updateByQueryRethrottle]] 887.`updateByQueryRethrottle(array $params = [])` 888**** 889[source,php] 890---- 891/* 892$params['task_id'] = (string) The task id to rethrottle 893$params['requests_per_second'] = (number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required) 894*/ 895---- 896**** 897 898 899 900[[Elasticsearch_ClientasyncSearch_asyncSearch]] 901.`asyncSearch()` 902**** 903[source,php] 904---- 905/* 906Returns the asyncSearch namespace 907*/ 908---- 909**** 910 911 912 913[[Elasticsearch_Clientautoscaling_autoscaling]] 914.`autoscaling()` 915**** 916[source,php] 917---- 918/* 919Returns the autoscaling namespace 920*/ 921---- 922**** 923 924 925 926[[Elasticsearch_Clientcat_cat]] 927.`cat()` 928**** 929[source,php] 930---- 931/* 932Returns the cat namespace 933*/ 934---- 935**** 936 937 938 939[[Elasticsearch_Clientccr_ccr]] 940.`ccr()` 941**** 942[source,php] 943---- 944/* 945Returns the ccr namespace 946*/ 947---- 948**** 949 950 951 952[[Elasticsearch_Clientcluster_cluster]] 953.`cluster()` 954**** 955[source,php] 956---- 957/* 958Returns the cluster namespace 959*/ 960---- 961**** 962 963 964 965[[Elasticsearch_ClientdanglingIndices_danglingIndices]] 966.`danglingIndices()` 967**** 968[source,php] 969---- 970/* 971Returns the danglingIndices namespace 972*/ 973---- 974**** 975 976 977 978[[Elasticsearch_ClientdataFrameTransformDeprecated_dataFrameTransformDeprecated]] 979.`dataFrameTransformDeprecated()` 980**** 981[source,php] 982---- 983/* 984Returns the dataFrameTransformDeprecated namespace 985*/ 986---- 987**** 988 989 990 991[[Elasticsearch_Clientenrich_enrich]] 992.`enrich()` 993**** 994[source,php] 995---- 996/* 997Returns the enrich namespace 998*/ 999---- 1000**** 1001 1002 1003 1004[[Elasticsearch_Clienteql_eql]] 1005.`eql()` 1006**** 1007[source,php] 1008---- 1009/* 1010Returns the eql namespace 1011*/ 1012---- 1013**** 1014 1015 1016 1017[[Elasticsearch_Clientfeatures_features]] 1018.`features()` 1019**** 1020[source,php] 1021---- 1022/* 1023Returns the features namespace 1024*/ 1025---- 1026**** 1027 1028 1029 1030[[Elasticsearch_Clientgraph_graph]] 1031.`graph()` 1032**** 1033[source,php] 1034---- 1035/* 1036Returns the graph namespace 1037*/ 1038---- 1039**** 1040 1041 1042 1043[[Elasticsearch_Clientilm_ilm]] 1044.`ilm()` 1045**** 1046[source,php] 1047---- 1048/* 1049Returns the ilm namespace 1050*/ 1051---- 1052**** 1053 1054 1055 1056[[Elasticsearch_Clientindices_indices]] 1057.`indices()` 1058**** 1059[source,php] 1060---- 1061/* 1062Returns the indices namespace 1063*/ 1064---- 1065**** 1066 1067 1068 1069[[Elasticsearch_Clientingest_ingest]] 1070.`ingest()` 1071**** 1072[source,php] 1073---- 1074/* 1075Returns the ingest namespace 1076*/ 1077---- 1078**** 1079 1080 1081 1082[[Elasticsearch_Clientlicense_license]] 1083.`license()` 1084**** 1085[source,php] 1086---- 1087/* 1088Returns the license namespace 1089*/ 1090---- 1091**** 1092 1093 1094 1095[[Elasticsearch_Clientlogstash_logstash]] 1096.`logstash()` 1097**** 1098[source,php] 1099---- 1100/* 1101Returns the logstash namespace 1102*/ 1103---- 1104**** 1105 1106 1107 1108[[Elasticsearch_Clientmigration_migration]] 1109.`migration()` 1110**** 1111[source,php] 1112---- 1113/* 1114Returns the migration namespace 1115*/ 1116---- 1117**** 1118 1119 1120 1121[[Elasticsearch_Clientml_ml]] 1122.`ml()` 1123**** 1124[source,php] 1125---- 1126/* 1127Returns the ml namespace 1128*/ 1129---- 1130**** 1131 1132 1133 1134[[Elasticsearch_Clientmonitoring_monitoring]] 1135.`monitoring()` 1136**** 1137[source,php] 1138---- 1139/* 1140Returns the monitoring namespace 1141*/ 1142---- 1143**** 1144 1145 1146 1147[[Elasticsearch_Clientnodes_nodes]] 1148.`nodes()` 1149**** 1150[source,php] 1151---- 1152/* 1153Returns the nodes namespace 1154*/ 1155---- 1156**** 1157 1158 1159 1160[[Elasticsearch_Clientrollup_rollup]] 1161.`rollup()` 1162**** 1163[source,php] 1164---- 1165/* 1166Returns the rollup namespace 1167*/ 1168---- 1169**** 1170 1171 1172 1173[[Elasticsearch_ClientsearchableSnapshots_searchableSnapshots]] 1174.`searchableSnapshots()` 1175**** 1176[source,php] 1177---- 1178/* 1179Returns the searchableSnapshots namespace 1180*/ 1181---- 1182**** 1183 1184 1185 1186[[Elasticsearch_Clientsecurity_security]] 1187.`security()` 1188**** 1189[source,php] 1190---- 1191/* 1192Returns the security namespace 1193*/ 1194---- 1195**** 1196 1197 1198 1199[[Elasticsearch_Clientslm_slm]] 1200.`slm()` 1201**** 1202[source,php] 1203---- 1204/* 1205Returns the slm namespace 1206*/ 1207---- 1208**** 1209 1210 1211 1212[[Elasticsearch_Clientsnapshot_snapshot]] 1213.`snapshot()` 1214**** 1215[source,php] 1216---- 1217/* 1218Returns the snapshot namespace 1219*/ 1220---- 1221**** 1222 1223 1224 1225[[Elasticsearch_Clientsql_sql]] 1226.`sql()` 1227**** 1228[source,php] 1229---- 1230/* 1231Returns the sql namespace 1232*/ 1233---- 1234**** 1235 1236 1237 1238[[Elasticsearch_Clientssl_ssl]] 1239.`ssl()` 1240**** 1241[source,php] 1242---- 1243/* 1244Returns the ssl namespace 1245*/ 1246---- 1247**** 1248 1249 1250 1251[[Elasticsearch_Clienttasks_tasks]] 1252.`tasks()` 1253**** 1254[source,php] 1255---- 1256/* 1257Returns the tasks namespace 1258*/ 1259---- 1260**** 1261 1262 1263 1264[[Elasticsearch_ClienttextStructure_textStructure]] 1265.`textStructure()` 1266**** 1267[source,php] 1268---- 1269/* 1270Returns the textStructure namespace 1271*/ 1272---- 1273**** 1274 1275 1276 1277[[Elasticsearch_Clienttransform_transform]] 1278.`transform()` 1279**** 1280[source,php] 1281---- 1282/* 1283Returns the transform namespace 1284*/ 1285---- 1286**** 1287 1288 1289 1290[[Elasticsearch_Clientwatcher_watcher]] 1291.`watcher()` 1292**** 1293[source,php] 1294---- 1295/* 1296Returns the watcher namespace 1297*/ 1298---- 1299**** 1300 1301 1302 1303[[Elasticsearch_Clientxpack_xpack]] 1304.`xpack()` 1305**** 1306[source,php] 1307---- 1308/* 1309Returns the xpack namespace 1310*/ 1311---- 1312**** 1313 1314 1315 1316[[Elasticsearch_Client-call-_call]] 1317.`__call(string $name, array $arguments)` 1318**** 1319[source,php] 1320---- 1321/* 1322Catchall for registered namespaces 1323*/ 1324---- 1325**** 1326 1327 1328 1329[[Elasticsearch_ClientextractArgument_extractArgument]] 1330.`extractArgument(array $params, string $arg)` 1331**** 1332[source,php] 1333---- 1334/* 1335Extract an argument from the array of parameters 1336*/ 1337---- 1338**** 1339 1340 1341