Connector

class elasticsearch_serverless.client.ConnectorClient(client: BaseClient)

check_in(*, connector_id: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Check in a connector.

Update the last_seen field in the connector and set it to the current timestamp.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in

Parameters:

connector_id – The unique identifier of the connector to be checked in

delete(*, connector_id: str, delete_sync_jobs: bool | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, hard: bool | None = None, human: bool | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Delete a connector.

Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete

Parameters:

• connector_id – The unique identifier of the connector to be deleted

• delete_sync_jobs – A flag indicating if associated sync jobs should be also removed. Defaults to false.

• hard – A flag indicating if the connector should be hard deleted.

get(*, connector_id: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, include_deleted: bool | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Get a connector.

Get the details about a connector.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get

Parameters:

• connector_id – The unique identifier of the connector

• include_deleted – A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.

list(*, connector_name: str | Sequence[str] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, from_: int | None = None, human: bool | None = None, include_deleted: bool | None = None, index_name: str | Sequence[str] | None = None, pretty: bool | None = None, query: str | None = None, service_type: str | Sequence[str] | None = None, size: int | None = None) → ObjectApiResponse[Any]

Get all connectors.

Get information about all connectors.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list

Parameters:

• connector_name – A comma-separated list of connector names to fetch connector documents for

• from – Starting offset (default: 0)

• include_deleted – A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.

• index_name – A comma-separated list of connector index names to fetch connector documents for

• query – A wildcard query string that filters connectors with matching name, description or index name

• service_type – A comma-separated list of connector service types to fetch connector documents for

• size – Specifies a max number of results to get

post(*, description: str | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, index_name: str | None = None, is_native: bool | None = None, language: str | None = None, name: str | None = None, pretty: bool | None = None, service_type: str | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Create a connector.

Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put

Parameters:

• description –

• index_name –

• is_native –

• language –

• name –

• service_type –

put(*, connector_id: str | None = None, description: str | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, index_name: str | None = None, is_native: bool | None = None, language: str | None = None, name: str | None = None, pretty: bool | None = None, service_type: str | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Create or update a connector.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put

Parameters:

• connector_id – The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.

• description –

• index_name –

• is_native –

• language –

• name –

• service_type –

sync_job_cancel(*, connector_sync_job_id: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Cancel a connector sync job.

Cancel a connector sync job, which sets the status to cancelling and updates cancellation_requested_at to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel

Parameters:

connector_sync_job_id – The unique identifier of the connector sync job

sync_job_delete(*, connector_sync_job_id: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Delete a connector sync job.

Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete

Parameters:

connector_sync_job_id – The unique identifier of the connector sync job to be deleted

sync_job_get(*, connector_sync_job_id: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Get a connector sync job.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get

Parameters:

connector_sync_job_id – The unique identifier of the connector sync job

sync_job_list(*, connector_id: str | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, from_: int | None = None, human: bool | None = None, job_type: Sequence[str | Literal['access_control', 'full', 'incremental']] | str | Literal['access_control', 'full', 'incremental'] | None = None, pretty: bool | None = None, size: int | None = None, status: str | Literal['canceled', 'canceling', 'completed', 'error', 'in_progress', 'pending', 'suspended'] | None = None) → ObjectApiResponse[Any]

Get all connector sync jobs.

Get information about all stored connector sync jobs listed by their creation date in ascending order.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list

Parameters:

• connector_id – A connector id to fetch connector sync jobs for

• from – Starting offset (default: 0)

• job_type – A comma-separated list of job types to fetch the sync jobs for

• size – Specifies a max number of results to get

• status – A sync job status to fetch connector sync jobs for

sync_job_post(*, id: str | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, job_type: str | Literal['access_control', 'full', 'incremental'] | None = None, pretty: bool | None = None, trigger_method: str | Literal['on_demand', 'scheduled'] | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Create a connector sync job.

Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post

Parameters:

• id – The id of the associated connector

• job_type –

• trigger_method –

update_active_filtering(*, connector_id: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Activate the connector draft filter.

Activates the valid draft filtering for a connector.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering

Parameters:

connector_id – The unique identifier of the connector to be updated

update_api_key_id(*, connector_id: str, api_key_id: str | None = None, api_key_secret_id: str | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector API key ID.

Update the api_key_id and api_key_secret_id fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id

Parameters:

• connector_id – The unique identifier of the connector to be updated

• api_key_id –

• api_key_secret_id –

update_configuration(*, connector_id: str, configuration: Mapping[str, Mapping[str, Any]] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, values: Mapping[str, Any] | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector configuration.

Update the configuration field in the connector document.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration

Parameters:

• connector_id – The unique identifier of the connector to be updated

• configuration –

• values –

update_error(*, connector_id: str, error: None | Any = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector error field.

Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error

Parameters:

• connector_id – The unique identifier of the connector to be updated

• error –

update_filtering(*, connector_id: str, advanced_snippet: Mapping[str, Any] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, filtering: Sequence[Mapping[str, Any]] | None = None, human: bool | None = None, pretty: bool | None = None, rules: Sequence[Mapping[str, Any]] | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector filtering.

Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering

Parameters:

• connector_id – The unique identifier of the connector to be updated

• advanced_snippet –

• filtering –

• rules –

update_filtering_validation(*, connector_id: str, validation: Mapping[str, Any] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector draft filtering validation.

Update the draft filtering validation info for a connector.

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

Parameters:

• connector_id – The unique identifier of the connector to be updated

• validation –

update_index_name(*, connector_id: str, index_name: None | Any = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector index name.

Update the index_name field of a connector, specifying the index where the data ingested by the connector is stored.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name

Parameters:

• connector_id – The unique identifier of the connector to be updated

• index_name –

update_name(*, connector_id: str, description: str | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, name: str | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector name and description.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name

Parameters:

• connector_id – The unique identifier of the connector to be updated

• description –

• name –

update_native(*, connector_id: str, is_native: bool | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector is_native flag.

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

Parameters:

• connector_id – The unique identifier of the connector to be updated

• is_native –

update_pipeline(*, connector_id: str, pipeline: Mapping[str, Any] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector pipeline.

When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline

Parameters:

• connector_id – The unique identifier of the connector to be updated

• pipeline –

update_scheduling(*, connector_id: str, scheduling: Mapping[str, Any] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector scheduling.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling

Parameters:

• connector_id – The unique identifier of the connector to be updated

• scheduling –

update_service_type(*, connector_id: str, service_type: str | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector service type.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type

Parameters:

• connector_id – The unique identifier of the connector to be updated

• service_type –

update_status(*, connector_id: str, status: str | Literal['configured', 'connected', 'created', 'error', 'needs_configuration'] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Update the connector status.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status

Parameters:

• connector_id – The unique identifier of the connector to be updated

• status –