Connector

class elasticsearch.client.ConnectorClient(client)

Parameters:: client (BaseClient)

check_in(*, connector_id, error_trace=None, filter_path=None, human=None, pretty=None)

Updates the last_seen timestamp in the connector document.

https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be checked in
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

delete(*, connector_id, delete_sync_jobs, error_trace=None, filter_path=None, human=None, pretty=None)

Deletes a connector.

https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be deleted
delete_sync_jobs (bool) – Determines whether associated sync jobs are also deleted.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

get(*, connector_id, error_trace=None, filter_path=None, human=None, pretty=None)

Returns the details about a connector.

https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-api.html

Parameters:

connector_id (str) – The unique identifier of the connector
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

last_sync(*, connector_id, error_trace=None, filter_path=None, human=None, last_access_control_sync_error=None, last_access_control_sync_scheduled_at=None, last_access_control_sync_status=None, last_deleted_document_count=None, last_incremental_sync_scheduled_at=None, last_indexed_document_count=None, last_seen=None, last_sync_error=None, last_sync_scheduled_at=None, last_sync_status=None, last_synced=None, pretty=None, body=None)

Updates the stats of last sync in the connector document.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-last-sync-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
last_access_control_sync_error (None | Any)
last_access_control_sync_scheduled_at (str | Any | None)
last_access_control_sync_status (Literal['canceled', 'canceling', 'completed', 'error', 'in_progress', 'pending', 'suspended'] | str | None)
last_deleted_document_count (int | None)
last_incremental_sync_scheduled_at (str | Any | None)
last_indexed_document_count (int | None)
last_seen (None | Any)
last_sync_error (None | Any)
last_sync_scheduled_at (str | Any | None)
last_sync_status (Literal['canceled', 'canceling', 'completed', 'error', 'in_progress', 'pending', 'suspended'] | str | None)
last_synced (str | Any | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

list(*, connector_name=None, error_trace=None, filter_path=None, from_=None, human=None, index_name=None, pretty=None, query=None, service_type=None, size=None)

Lists all connectors.

https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-api.html

Parameters:

connector_name (str | Sequence[str] | None) – A comma-separated list of connector names to fetch connector documents for
from – Starting offset (default: 0)
index_name (str | Sequence[str] | None) – A comma-separated list of connector index names to fetch connector documents for
query (str | None) – A wildcard query string that filters connectors with matching name, description or index name
service_type (str | Sequence[str] | None) – A comma-separated list of connector service types to fetch connector documents for
size (int | None) – Specifies a max number of results to get
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

post(*, index_name=None, description=None, error_trace=None, filter_path=None, human=None, is_native=None, language=None, name=None, pretty=None, service_type=None, body=None)

Creates a connector.

https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html

Parameters:

index_name (None | Any)
description (str | None)
is_native (bool | None)
language (str | None)
name (str | None)
service_type (str | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

put(*, connector_id, index_name=None, description=None, error_trace=None, filter_path=None, human=None, is_native=None, language=None, name=None, pretty=None, service_type=None, body=None)

Creates or updates a connector.

https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be created or updated
index_name (None | Any)
description (str | None)
is_native (bool | None)
language (str | None)
name (str | None)
service_type (str | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

sync_job_cancel(*, connector_sync_job_id, error_trace=None, filter_path=None, human=None, pretty=None)

Cancels a connector sync job.

https://www.elastic.co/guide/en/elasticsearch/reference/master/cancel-connector-sync-job-api.html

Parameters:

connector_sync_job_id (str) – The unique identifier of the connector sync job
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

sync_job_delete(*, connector_sync_job_id, error_trace=None, filter_path=None, human=None, pretty=None)

Deletes a connector sync job.

https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-sync-job-api.html

Parameters:

connector_sync_job_id (str) – The unique identifier of the connector sync job to be deleted
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

sync_job_get(*, connector_sync_job_id, error_trace=None, filter_path=None, human=None, pretty=None)

Returns the details about a connector sync job.

https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-sync-job-api.html

Parameters:

connector_sync_job_id (str) – The unique identifier of the connector sync job
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

sync_job_list(*, connector_id=None, error_trace=None, filter_path=None, from_=None, human=None, job_type=None, pretty=None, size=None, status=None)

Lists all connector sync jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-sync-jobs-api.html

Parameters:

connector_id (str | None) – A connector id to fetch connector sync jobs for
from – Starting offset (default: 0)
job_type (Sequence[Literal['access_control', 'full', 'incremental'] | str] | None) – A comma-separated list of job types to fetch the sync jobs for
size (int | None) – Specifies a max number of results to get
status (Literal['canceled', 'canceling', 'completed', 'error', 'in_progress', 'pending', 'suspended'] | str | None) – A sync job status to fetch connector sync jobs for
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

sync_job_post(*, id=None, error_trace=None, filter_path=None, human=None, job_type=None, pretty=None, trigger_method=None, body=None)

Creates a connector sync job.

https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-sync-job-api.html

Parameters:

id (str | None) – The id of the associated connector
job_type (Literal['access_control', 'full', 'incremental'] | str | None)
trigger_method (Literal['on_demand', 'scheduled'] | str | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_active_filtering(*, connector_id, error_trace=None, filter_path=None, human=None, pretty=None)

Activates the draft filtering rules if they are in a validated state.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

update_api_key_id(*, connector_id, api_key_id=None, api_key_secret_id=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the API key id and/or API key secret id fields in the connector document.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-api-key-id-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
api_key_id (None | Any)
api_key_secret_id (None | Any)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_configuration(*, connector_id, configuration=None, error_trace=None, filter_path=None, human=None, pretty=None, values=None, body=None)

Updates the connector configuration.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-configuration-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
configuration (Mapping[str, Mapping[str, Any]] | None)
values (Mapping[str, Any] | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_error(*, connector_id, error=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the error field in the connector document.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-error-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
error (None | Any)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_filtering(*, connector_id, advanced_snippet=None, error_trace=None, filter_path=None, filtering=None, human=None, pretty=None, rules=None, body=None)

Updates the filtering field in the connector document.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
advanced_snippet (Mapping[str, Any] | None)
filtering (Sequence[Mapping[str, Any]] | None)
rules (Sequence[Mapping[str, Any]] | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_filtering_validation(*, connector_id, validation=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the validation info of the draft filtering rules.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-validation-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
validation (Mapping[str, Any] | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_index_name(*, connector_id, index_name=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the index name of the connector.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-index-name-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
index_name (None | Any)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_name(*, connector_id, name=None, description=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the name and/or description fields in the connector document.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-name-description-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
name (str | None)
description (str | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_native(*, connector_id, is_native=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the is_native flag of the connector.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-native-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
is_native (bool | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_pipeline(*, connector_id, pipeline=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the pipeline field in the connector document.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-pipeline-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
pipeline (Mapping[str, Any] | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_scheduling(*, connector_id, scheduling=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the scheduling field in the connector document.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-scheduling-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
scheduling (Mapping[str, Any] | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_service_type(*, connector_id, service_type=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the service type of the connector.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-service-type-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
service_type (str | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]

update_status(*, connector_id, status=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

Updates the status of the connector.

https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-status-api.html

Parameters:

connector_id (str) – The unique identifier of the connector to be updated
status (Literal['configured', 'connected', 'created', 'error', 'needs_configuration'] | str | None)
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)
body (Dict[str, Any] | None)

Return type:

ObjectApiResponse[Any]