Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/elasticsearch/elasticsearch/src/Elasticsearch/Namespaces/ |
<?php
/**
* Elasticsearch PHP client
*
* @link https://github.com/elastic/elasticsearch-php/
* @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* @license https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1
*
* Licensed to Elasticsearch B.V under one or more agreements.
* Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
* the GNU Lesser General Public License, Version 2.1, at your option.
* See the LICENSE file in the project root for more information.
*/
declare(strict_types = 1);
namespace Elasticsearch\Namespaces;
use Elasticsearch\Namespaces\AbstractNamespace;
/**
* Class NodesNamespace
*
* NOTE: this file is autogenerated using util/GenerateEndpoints.php
* and Elasticsearch 7.17.0 (bee86328705acaa9a6daede7140defd4d9ec56bd)
*/
class NodesNamespace extends AbstractNamespace
{
/**
* Removes the archived repositories metering information present in the cluster.
*
* $params['node_id'] = (list) Comma-separated list of node IDs or names used to limit returned information.
* $params['max_archive_version'] = (long) Specifies the maximum archive_version to be cleared from the archive.
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html
*
* @note This API is EXPERIMENTAL and may be changed or removed completely in a future release
*
*/
public function clearRepositoriesMeteringArchive(array $params = [])
{
$node_id = $this->extractArgument($params, 'node_id');
$max_archive_version = $this->extractArgument($params, 'max_archive_version');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Nodes\ClearRepositoriesMeteringArchive');
$endpoint->setParams($params);
$endpoint->setNodeId($node_id);
$endpoint->setMaxArchiveVersion($max_archive_version);
return $this->performRequest($endpoint);
}
/**
* Returns cluster repositories metering information.
*
* $params['node_id'] = (list) A comma-separated list of node IDs or names to limit the returned information.
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html
*
* @note This API is EXPERIMENTAL and may be changed or removed completely in a future release
*
*/
public function getRepositoriesMeteringInfo(array $params = [])
{
$node_id = $this->extractArgument($params, 'node_id');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Nodes\GetRepositoriesMeteringInfo');
$endpoint->setParams($params);
$endpoint->setNodeId($node_id);
return $this->performRequest($endpoint);
}
/**
* Returns information about hot threads on each node in the cluster.
*
* $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
* $params['interval'] = (time) The interval for the second sampling of threads
* $params['snapshots'] = (number) Number of samples of thread stacktrace (default: 10)
* $params['threads'] = (number) Specify the number of threads to provide information for (default: 3)
* $params['ignore_idle_threads'] = (boolean) Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
* $params['type'] = (enum) The type to sample (default: cpu) (Options = cpu,wait,block,mem)
* $params['sort'] = (enum) The sort order for 'cpu' type (default: total) (Options = cpu,total)
* $params['timeout'] = (time) Explicit operation timeout
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html
*/
public function hotThreads(array $params = [])
{
$node_id = $this->extractArgument($params, 'node_id');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Nodes\HotThreads');
$endpoint->setParams($params);
$endpoint->setNodeId($node_id);
return $this->performRequest($endpoint);
}
/**
* Returns information about nodes in the cluster.
*
* $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
* $params['metric'] = (list) A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics.
* $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
* $params['timeout'] = (time) Explicit operation timeout
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html
*/
public function info(array $params = [])
{
$node_id = $this->extractArgument($params, 'node_id');
$metric = $this->extractArgument($params, 'metric');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Nodes\Info');
$endpoint->setParams($params);
$endpoint->setNodeId($node_id);
$endpoint->setMetric($metric);
return $this->performRequest($endpoint);
}
/**
* Reloads secure settings.
*
* $params['node_id'] = (list) A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
* $params['timeout'] = (time) Explicit operation timeout
* $params['body'] = (array) An object containing the password for the elasticsearch keystore
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings
*/
public function reloadSecureSettings(array $params = [])
{
$node_id = $this->extractArgument($params, 'node_id');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Nodes\ReloadSecureSettings');
$endpoint->setParams($params);
$endpoint->setNodeId($node_id);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* Returns statistical information about nodes in the cluster.
*
* $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
* $params['metric'] = (list) Limit the information returned to the specified metrics
* $params['index_metric'] = (list) Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.
* $params['completion_fields'] = (list) A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
* $params['fielddata_fields'] = (list) A comma-separated list of fields for `fielddata` index metric (supports wildcards)
* $params['fields'] = (list) A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
* $params['groups'] = (boolean) A comma-separated list of search groups for `search` index metric
* $params['level'] = (enum) Return indices stats aggregated at index, node or shard level (Options = indices,node,shards) (Default = node)
* $params['types'] = (list) A comma-separated list of document types for the `indexing` index metric
* $params['timeout'] = (time) Explicit operation timeout
* $params['include_segment_file_sizes'] = (boolean) Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) (Default = false)
* $params['include_unloaded_segments'] = (boolean) If set to true segment stats will include stats for segments that are not currently loaded into memory (Default = false)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html
*/
public function stats(array $params = [])
{
$node_id = $this->extractArgument($params, 'node_id');
$metric = $this->extractArgument($params, 'metric');
$index_metric = $this->extractArgument($params, 'index_metric');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Nodes\Stats');
$endpoint->setParams($params);
$endpoint->setNodeId($node_id);
$endpoint->setMetric($metric);
$endpoint->setIndexMetric($index_metric);
return $this->performRequest($endpoint);
}
/**
* Returns low-level information about REST actions usage on nodes.
*
* $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
* $params['metric'] = (list) Limit the information returned to the specified metrics
* $params['timeout'] = (time) Explicit operation timeout
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html
*/
public function usage(array $params = [])
{
$node_id = $this->extractArgument($params, 'node_id');
$metric = $this->extractArgument($params, 'metric');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Nodes\Usage');
$endpoint->setParams($params);
$endpoint->setNodeId($node_id);
$endpoint->setMetric($metric);
return $this->performRequest($endpoint);
}
}