1 2 3[[Elasticsearch_Namespaces_ClusterNamespace]] 4=== Elasticsearch\Namespaces\ClusterNamespace 5 6 7 8Class ClusterNamespace 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_ClusterNamespaceallocationExplain_allocationExplain,`allocationExplain()`>> 22* <<Elasticsearch_Namespaces_ClusterNamespacedeleteComponentTemplate_deleteComponentTemplate,`deleteComponentTemplate()`>> 23* <<Elasticsearch_Namespaces_ClusterNamespacedeleteVotingConfigExclusions_deleteVotingConfigExclusions,`deleteVotingConfigExclusions()`>> 24* <<Elasticsearch_Namespaces_ClusterNamespaceexistsComponentTemplate_existsComponentTemplate,`existsComponentTemplate()`>> 25* <<Elasticsearch_Namespaces_ClusterNamespacegetComponentTemplate_getComponentTemplate,`getComponentTemplate()`>> 26* <<Elasticsearch_Namespaces_ClusterNamespacegetSettings_getSettings,`getSettings()`>> 27* <<Elasticsearch_Namespaces_ClusterNamespacehealth_health,`health()`>> 28* <<Elasticsearch_Namespaces_ClusterNamespacependingTasks_pendingTasks,`pendingTasks()`>> 29* <<Elasticsearch_Namespaces_ClusterNamespacepostVotingConfigExclusions_postVotingConfigExclusions,`postVotingConfigExclusions()`>> 30* <<Elasticsearch_Namespaces_ClusterNamespaceputComponentTemplate_putComponentTemplate,`putComponentTemplate()`>> 31* <<Elasticsearch_Namespaces_ClusterNamespaceputSettings_putSettings,`putSettings()`>> 32* <<Elasticsearch_Namespaces_ClusterNamespaceremoteInfo_remoteInfo,`remoteInfo()`>> 33* <<Elasticsearch_Namespaces_ClusterNamespacereroute_reroute,`reroute()`>> 34* <<Elasticsearch_Namespaces_ClusterNamespacestate_state,`state()`>> 35* <<Elasticsearch_Namespaces_ClusterNamespacestats_stats,`stats()`>> 36 37 38 39[[Elasticsearch_Namespaces_ClusterNamespaceallocationExplain_allocationExplain]] 40.`allocationExplain(array $params = [])` 41**** 42[source,php] 43---- 44/* 45$params['include_yes_decisions'] = (boolean) Return 'YES' decisions in explanation (default: false) 46$params['include_disk_info'] = (boolean) Return information about disk usage and shard sizes (default: false) 47$params['body'] = (array) The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' 48*/ 49---- 50**** 51 52 53 54[[Elasticsearch_Namespaces_ClusterNamespacedeleteComponentTemplate_deleteComponentTemplate]] 55.`deleteComponentTemplate(array $params = [])` 56**** 57[source,php] 58---- 59/* 60$params['name'] = (string) The name of the template 61$params['timeout'] = (time) Explicit operation timeout 62$params['master_timeout'] = (time) Specify timeout for connection to master 63*/ 64---- 65**** 66 67 68 69[[Elasticsearch_Namespaces_ClusterNamespacedeleteVotingConfigExclusions_deleteVotingConfigExclusions]] 70.`deleteVotingConfigExclusions(array $params = [])` 71**** 72[source,php] 73---- 74/* 75$params['wait_for_removal'] = (boolean) Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. (Default = true) 76*/ 77---- 78**** 79 80 81 82[[Elasticsearch_Namespaces_ClusterNamespaceexistsComponentTemplate_existsComponentTemplate]] 83.`existsComponentTemplate(array $params = [])` 84**** 85[source,php] 86---- 87/* 88$params['name'] = (string) The name of the template 89$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 90$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 91*/ 92---- 93**** 94 95 96 97[[Elasticsearch_Namespaces_ClusterNamespacegetComponentTemplate_getComponentTemplate]] 98.`getComponentTemplate(array $params = [])` 99**** 100[source,php] 101---- 102/* 103$params['name'] = (list) The comma separated names of the component templates 104$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 105$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 106*/ 107---- 108**** 109 110 111 112[[Elasticsearch_Namespaces_ClusterNamespacegetSettings_getSettings]] 113.`getSettings(array $params = [])` 114**** 115[source,php] 116---- 117/* 118$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 119$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 120$params['timeout'] = (time) Explicit operation timeout 121$params['include_defaults'] = (boolean) Whether to return all default clusters setting. (Default = false) 122*/ 123---- 124**** 125 126 127 128[[Elasticsearch_Namespaces_ClusterNamespacehealth_health]] 129.`health(array $params = [])` 130**** 131[source,php] 132---- 133/* 134$params['index'] = (list) Limit the information returned to a specific index 135$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) 136$params['level'] = (enum) Specify the level of detail for returned information (Options = cluster,indices,shards) (Default = cluster) 137$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 138$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 139$params['timeout'] = (time) Explicit operation timeout 140$params['wait_for_active_shards'] = (string) Wait until the specified number of shards is active 141$params['wait_for_nodes'] = (string) Wait until the specified number of nodes is available 142$params['wait_for_events'] = (enum) Wait until all currently queued events with the given priority are processed (Options = immediate,urgent,high,normal,low,languid) 143$params['wait_for_no_relocating_shards'] = (boolean) Whether to wait until there are no relocating shards in the cluster 144$params['wait_for_no_initializing_shards'] = (boolean) Whether to wait until there are no initializing shards in the cluster 145$params['wait_for_status'] = (enum) Wait until cluster is in a specific state (Options = green,yellow,red) 146*/ 147---- 148**** 149 150 151 152[[Elasticsearch_Namespaces_ClusterNamespacependingTasks_pendingTasks]] 153.`pendingTasks(array $params = [])` 154**** 155[source,php] 156---- 157/* 158$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 159$params['master_timeout'] = (time) Specify timeout for connection to master 160*/ 161---- 162**** 163 164 165 166[[Elasticsearch_Namespaces_ClusterNamespacepostVotingConfigExclusions_postVotingConfigExclusions]] 167.`postVotingConfigExclusions(array $params = [])` 168**** 169[source,php] 170---- 171/* 172$params['node_ids'] = (string) A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names. 173*/ 174---- 175**** 176 177 178 179[[Elasticsearch_Namespaces_ClusterNamespaceputComponentTemplate_putComponentTemplate]] 180.`putComponentTemplate(array $params = [])` 181**** 182[source,php] 183---- 184/* 185$params['name'] = (string) The name of the template 186$params['create'] = (boolean) Whether the index template should only be added if new or can also replace an existing one (Default = false) 187$params['timeout'] = (time) Explicit operation timeout 188$params['master_timeout'] = (time) Specify timeout for connection to master 189$params['body'] = (array) The template definition (Required) 190*/ 191---- 192**** 193 194 195 196[[Elasticsearch_Namespaces_ClusterNamespaceputSettings_putSettings]] 197.`putSettings(array $params = [])` 198**** 199[source,php] 200---- 201/* 202$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 203$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 204$params['timeout'] = (time) Explicit operation timeout 205$params['body'] = (array) The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (Required) 206*/ 207---- 208**** 209 210 211 212[[Elasticsearch_Namespaces_ClusterNamespaceremoteInfo_remoteInfo]] 213.`remoteInfo(array $params = [])` 214**** 215[source,php] 216---- 217/* 218*/ 219---- 220**** 221 222 223 224[[Elasticsearch_Namespaces_ClusterNamespacereroute_reroute]] 225.`reroute(array $params = [])` 226**** 227[source,php] 228---- 229/* 230$params['dry_run'] = (boolean) Simulate the operation only and return the resulting state 231$params['explain'] = (boolean) Return an explanation of why the commands can or cannot be executed 232$params['retry_failed'] = (boolean) Retries allocation of shards that are blocked due to too many subsequent allocation failures 233$params['metric'] = (list) Limit the information returned to the specified metrics. Defaults to all but metadata (Options = _all,blocks,metadata,nodes,routing_table,master_node,version) 234$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 235$params['timeout'] = (time) Explicit operation timeout 236$params['body'] = (array) The definition of `commands` to perform (`move`, `cancel`, `allocate`) 237*/ 238---- 239**** 240 241 242 243[[Elasticsearch_Namespaces_ClusterNamespacestate_state]] 244.`state(array $params = [])` 245**** 246[source,php] 247---- 248/* 249$params['metric'] = (list) Limit the information returned to the specified metrics 250$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices 251$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 252$params['master_timeout'] = (time) Specify timeout for connection to master 253$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 254$params['wait_for_metadata_version'] = (number) Wait for the metadata version to be equal or greater than the specified metadata version 255$params['wait_for_timeout'] = (time) The maximum time to wait for wait_for_metadata_version before timing out 256$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) 257$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) 258$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) 259*/ 260---- 261**** 262 263 264 265[[Elasticsearch_Namespaces_ClusterNamespacestats_stats]] 266.`stats(array $params = [])` 267**** 268[source,php] 269---- 270/* 271$params['node_id'] = (list) A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes 272$params['flat_settings'] = (boolean) Return settings in flat format (default: false) 273$params['timeout'] = (time) Explicit operation timeout 274*/ 275---- 276**** 277 278 279