-
Notifications
You must be signed in to change notification settings - Fork 972
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
1,018 additions
and
3 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,322 @@ | ||
<?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 ConnectorSyncJob extends AbstractEndpoint | ||
{ | ||
/** | ||
* Cancels a connector sync job. | ||
* | ||
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cancel-connector-sync-job-api.html | ||
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release | ||
* | ||
* @param array{ | ||
* connector_sync_job_id: string, // (REQUIRED) The unique identifier of the connector sync job to be canceled | ||
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false) | ||
* human: boolean, // Return human readable values for statistics. (DEFAULT: true) | ||
* error_trace: boolean, // 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: list, // 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 cancel(array $params = []) | ||
{ | ||
$this->checkRequiredParameters(['connector_sync_job_id'], $params); | ||
$url = '/_connector/_sync_job/' . $this->encode($params['connector_sync_job_id']) . '/_cancel'; | ||
$method = 'PUT'; | ||
|
||
$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']); | ||
$headers = [ | ||
'Accept' => 'application/json', | ||
]; | ||
return $this->client->sendRequest($this->createRequest($method, $url, $headers, $params['body'] ?? null)); | ||
} | ||
|
||
|
||
/** | ||
* Checks in a connector sync job (refreshes 'last_seen'). | ||
* | ||
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html | ||
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release | ||
* | ||
* @param array{ | ||
* connector_sync_job_id: string, // (REQUIRED) The unique identifier of the connector sync job to be checked in | ||
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false) | ||
* human: boolean, // Return human readable values for statistics. (DEFAULT: true) | ||
* error_trace: boolean, // 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: list, // 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 checkIn(array $params = []) | ||
{ | ||
$this->checkRequiredParameters(['connector_sync_job_id'], $params); | ||
$url = '/_connector/_sync_job/' . $this->encode($params['connector_sync_job_id']) . '/_check_in'; | ||
$method = 'PUT'; | ||
|
||
$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']); | ||
$headers = [ | ||
'Accept' => 'application/json', | ||
]; | ||
return $this->client->sendRequest($this->createRequest($method, $url, $headers, $params['body'] ?? null)); | ||
} | ||
|
||
|
||
/** | ||
* Deletes a connector sync job. | ||
* | ||
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-sync-job-api.html | ||
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release | ||
* | ||
* @param array{ | ||
* connector_sync_job_id: string, // (REQUIRED) The unique identifier of the connector sync job to be deleted. | ||
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false) | ||
* human: boolean, // Return human readable values for statistics. (DEFAULT: true) | ||
* error_trace: boolean, // 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: list, // 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 delete(array $params = []) | ||
{ | ||
$this->checkRequiredParameters(['connector_sync_job_id'], $params); | ||
$url = '/_connector/_sync_job/' . $this->encode($params['connector_sync_job_id']); | ||
$method = 'DELETE'; | ||
|
||
$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']); | ||
$headers = [ | ||
'Accept' => 'application/json', | ||
]; | ||
return $this->client->sendRequest($this->createRequest($method, $url, $headers, $params['body'] ?? null)); | ||
} | ||
|
||
|
||
/** | ||
* Sets an error for a connector sync job. | ||
* | ||
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-error-api.html | ||
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release | ||
* | ||
* @param array{ | ||
* connector_sync_job_id: string, // (REQUIRED) The unique identifier of the connector sync job to set an error for. | ||
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false) | ||
* human: boolean, // Return human readable values for statistics. (DEFAULT: true) | ||
* error_trace: boolean, // 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: list, // A comma-separated list of filters used to reduce the response. | ||
* body: array, // (REQUIRED) The error to set in the connector sync job. | ||
* } $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 error(array $params = []) | ||
{ | ||
$this->checkRequiredParameters(['connector_sync_job_id','body'], $params); | ||
$url = '/_connector/_sync_job/' . $this->encode($params['connector_sync_job_id']) . '/_error'; | ||
$method = 'PUT'; | ||
|
||
$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']); | ||
$headers = [ | ||
'Accept' => 'application/json', | ||
'Content-Type' => 'application/json', | ||
]; | ||
return $this->client->sendRequest($this->createRequest($method, $url, $headers, $params['body'] ?? null)); | ||
} | ||
|
||
|
||
/** | ||
* Returns the details about a connector sync job. | ||
* | ||
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-sync-job-api.html | ||
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release | ||
* | ||
* @param array{ | ||
* connector_sync_job_id: string, // (REQUIRED) The unique identifier of the connector sync job to be returned. | ||
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false) | ||
* human: boolean, // Return human readable values for statistics. (DEFAULT: true) | ||
* error_trace: boolean, // 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: list, // 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 get(array $params = []) | ||
{ | ||
$this->checkRequiredParameters(['connector_sync_job_id'], $params); | ||
$url = '/_connector/_sync_job/' . $this->encode($params['connector_sync_job_id']); | ||
$method = 'GET'; | ||
|
||
$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']); | ||
$headers = [ | ||
'Accept' => 'application/json', | ||
]; | ||
return $this->client->sendRequest($this->createRequest($method, $url, $headers, $params['body'] ?? null)); | ||
} | ||
|
||
|
||
/** | ||
* Lists all connector sync jobs. | ||
* | ||
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-sync-jobs-api.html | ||
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release | ||
* | ||
* @param array{ | ||
* from: int, // Starting offset (default: 0) | ||
* size: int, // specifies a max number of results to get (default: 100) | ||
* status: string, // Sync job status, which sync jobs are fetched for | ||
* connector_id: string, // Id of the connector to fetch the sync jobs for | ||
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false) | ||
* human: boolean, // Return human readable values for statistics. (DEFAULT: true) | ||
* error_trace: boolean, // 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: list, // 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 list(array $params = []) | ||
{ | ||
$url = '/_connector/_sync_job'; | ||
$method = 'GET'; | ||
|
||
$url = $this->addQueryString($url, $params, ['from','size','status','connector_id','pretty','human','error_trace','source','filter_path']); | ||
$headers = [ | ||
'Accept' => 'application/json', | ||
]; | ||
return $this->client->sendRequest($this->createRequest($method, $url, $headers, $params['body'] ?? null)); | ||
} | ||
|
||
|
||
/** | ||
* Creates a connector sync job. | ||
* | ||
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-sync-job-api.html | ||
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release | ||
* | ||
* @param array{ | ||
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false) | ||
* human: boolean, // Return human readable values for statistics. (DEFAULT: true) | ||
* error_trace: boolean, // 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: list, // A comma-separated list of filters used to reduce the response. | ||
* body: array, // (REQUIRED) The connector sync job data. | ||
* } $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 post(array $params = []) | ||
{ | ||
$this->checkRequiredParameters(['body'], $params); | ||
$url = '/_connector/_sync_job'; | ||
$method = 'POST'; | ||
|
||
$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']); | ||
$headers = [ | ||
'Accept' => 'application/json', | ||
'Content-Type' => 'application/json', | ||
]; | ||
return $this->client->sendRequest($this->createRequest($method, $url, $headers, $params['body'] ?? null)); | ||
} | ||
|
||
|
||
/** | ||
* Updates the stats fields in the connector sync job document. | ||
* | ||
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-stats-api.html | ||
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release | ||
* | ||
* @param array{ | ||
* connector_sync_job_id: string, // (REQUIRED) The unique identifier of the connector sync job to be updated. | ||
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false) | ||
* human: boolean, // Return human readable values for statistics. (DEFAULT: true) | ||
* error_trace: boolean, // 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: list, // A comma-separated list of filters used to reduce the response. | ||
* body: array, // (REQUIRED) The stats to update for the connector sync job. | ||
* } $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 updateStats(array $params = []) | ||
{ | ||
$this->checkRequiredParameters(['connector_sync_job_id','body'], $params); | ||
$url = '/_connector/_sync_job/' . $this->encode($params['connector_sync_job_id']) . '/_stats'; | ||
$method = 'PUT'; | ||
|
||
$url = $this->addQueryString($url, $params, ['pretty','human','error_trace','source','filter_path']); | ||
$headers = [ | ||
'Accept' => 'application/json', | ||
'Content-Type' => 'application/json', | ||
]; | ||
return $this->client->sendRequest($this->createRequest($method, $url, $headers, $params['body'] ?? null)); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.