whoami7 - Manager
:
/
home
/
qbizpnmr
/
arif.umairtax.com
/
vendor
/
elasticsearch
/
elasticsearch
/
src
/
Endpoints
/
Upload File:
files >> /home/qbizpnmr/arif.umairtax.com/vendor/elasticsearch/elasticsearch/src/Endpoints/Slm.php
<?php /** * Elasticsearch PHP Client * * @link https://github.com/elastic/elasticsearch-php * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co) * @license https://opensource.org/licenses/MIT MIT License * * Licensed to Elasticsearch B.V under one or more agreements. * Elasticsearch B.V licenses this file to you under the MIT License. * See the LICENSE file in the project root for more information. */ declare(strict_types=1); namespace Elastic\Elasticsearch\Endpoints; use Elastic\Elasticsearch\Exception\ClientResponseException; use Elastic\Elasticsearch\Exception\MissingParameterException; use Elastic\Elasticsearch\Exception\ServerResponseException; use Elastic\Elasticsearch\Response\Elasticsearch; use Elastic\Transport\Exception\NoNodeAvailableException; use Http\Promise\Promise; /** * @generated This file is generated, please do not edit */ class Slm extends AbstractEndpoint { /** * Deletes an existing snapshot lifecycle policy. * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html * * @param array{ * policy_id: string, // (REQUIRED) The id of the snapshot lifecycle policy to remove * master_timeout?: int|string, // Explicit operation timeout for connection to master node * timeout?: int|string, // Explicit operation timeout * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * } $params * * @throws MissingParameterException if a required parameter is missing * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function deleteLifecycle(?array $params = null) { $params = $params ?? []; $this->checkRequiredParameters(['policy_id'], $params); $url = '/_slm/policy/' . $this->encode($params['policy_id']); $method = 'DELETE'; $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, ['policy_id'], $request, 'slm.delete_lifecycle'); return $this->client->sendRequest($request); } /** * Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html * * @param array{ * policy_id: string, // (REQUIRED) The id of the snapshot lifecycle policy to be executed * master_timeout?: int|string, // Explicit operation timeout for connection to master node * timeout?: int|string, // Explicit operation timeout * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * } $params * * @throws MissingParameterException if a required parameter is missing * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function executeLifecycle(?array $params = null) { $params = $params ?? []; $this->checkRequiredParameters(['policy_id'], $params); $url = '/_slm/policy/' . $this->encode($params['policy_id']) . '/_execute'; $method = 'PUT'; $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, ['policy_id'], $request, 'slm.execute_lifecycle'); return $this->client->sendRequest($request); } /** * Deletes any snapshots that are expired according to the policy's retention rules. * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html * * @param array{ * master_timeout?: int|string, // Explicit operation timeout for connection to master node * timeout?: int|string, // Explicit operation timeout * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * } $params * * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function executeRetention(?array $params = null) { $params = $params ?? []; $url = '/_slm/_execute_retention'; $method = 'POST'; $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, [], $request, 'slm.execute_retention'); return $this->client->sendRequest($request); } /** * Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html * * @param array{ * policy_id?: string|array<string>, // Comma-separated list of snapshot lifecycle policies to retrieve * master_timeout?: int|string, // Explicit operation timeout for connection to master node * timeout?: int|string, // Explicit operation timeout * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * } $params * * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function getLifecycle(?array $params = null) { $params = $params ?? []; if (isset($params['policy_id'])) { $url = '/_slm/policy/' . $this->encode($this->convertValue($params['policy_id'])); $method = 'GET'; } else { $url = '/_slm/policy'; $method = 'GET'; } $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, ['policy_id'], $request, 'slm.get_lifecycle'); return $this->client->sendRequest($request); } /** * Returns global and policy-level statistics about actions taken by snapshot lifecycle management. * * @see https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html * * @param array{ * master_timeout?: int|string, // Explicit operation timeout for connection to master node * timeout?: int|string, // Explicit operation timeout * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * } $params * * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function getStats(?array $params = null) { $params = $params ?? []; $url = '/_slm/stats'; $method = 'GET'; $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, [], $request, 'slm.get_stats'); return $this->client->sendRequest($request); } /** * Retrieves the status of snapshot lifecycle management (SLM). * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html * * @param array{ * master_timeout?: int|string, // Explicit operation timeout for connection to master node * timeout?: int|string, // Explicit operation timeout * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * } $params * * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function getStatus(?array $params = null) { $params = $params ?? []; $url = '/_slm/status'; $method = 'GET'; $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, [], $request, 'slm.get_status'); return $this->client->sendRequest($request); } /** * Creates or updates a snapshot lifecycle policy. * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html * * @param array{ * policy_id: string, // (REQUIRED) The id of the snapshot lifecycle policy * master_timeout?: int|string, // Explicit operation timeout for connection to master node * timeout?: int|string, // Explicit operation timeout * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * body?: string|array<mixed>, // The snapshot lifecycle policy definition to register. If body is a string must be a valid JSON. * } $params * * @throws MissingParameterException if a required parameter is missing * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function putLifecycle(?array $params = null) { $params = $params ?? []; $this->checkRequiredParameters(['policy_id'], $params); $url = '/_slm/policy/' . $this->encode($params['policy_id']); $method = 'PUT'; $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', 'Content-Type' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, ['policy_id'], $request, 'slm.put_lifecycle'); return $this->client->sendRequest($request); } /** * Turns on snapshot lifecycle management (SLM). * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html * * @param array{ * master_timeout?: int|string, // Timeout for processing on master node * timeout?: int|string, // Timeout for acknowledgement of update from all nodes in cluster * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * } $params * * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function start(?array $params = null) { $params = $params ?? []; $url = '/_slm/start'; $method = 'POST'; $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, [], $request, 'slm.start'); return $this->client->sendRequest($request); } /** * Turns off snapshot lifecycle management (SLM). * * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html * * @param array{ * master_timeout?: int|string, // Timeout for processing on master node * timeout?: int|string, // Timeout for acknowledgement of update from all nodes in cluster * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) * source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response. * } $params * * @throws NoNodeAvailableException if all the hosts are offline * @throws ClientResponseException if the status code of response is 4xx * @throws ServerResponseException if the status code of response is 5xx * * @return Elasticsearch|Promise */ public function stop(?array $params = null) { $params = $params ?? []; $url = '/_slm/stop'; $method = 'POST'; $url = $this->addQueryString($url, $params, ['master_timeout','timeout','pretty','human','error_trace','source','filter_path']); $headers = [ 'Accept' => 'application/json', ]; $request = $this->createRequest($method, $url, $headers, $params['body'] ?? null); $request = $this->addOtelAttributes($params, [], $request, 'slm.stop'); return $this->client->sendRequest($request); } }
Copyright ©2021 || Defacer Indonesia