elasticsearch-js/docs/reference/api/Connector.md

Connector

Constructor

::: new Connector(transport: Transport); :::

Properties

Name	Type	Description
acceptedParams	Record<string, { path: string[]; body: string[]; query: string[]; }>
transport	Transport

Methods

Name	Signature	Description
checkIn	checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md)>;	Check in a connector. Update the last_seen field in the connector and set it to the current timestamp.
checkIn	checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md), unknown>>;
checkIn	checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md)>;
delete	delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md)>;	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.
delete	delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md), unknown>>;
delete	delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md)>;
get	get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorGetResponse](./ConnectorGetResponse.md)>;	Get a connector. Get the details about a connector.
get	get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorGetResponse](./ConnectorGetResponse.md), unknown>>;
get	get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorGetResponse](./ConnectorGetResponse.md)>;
lastSync	lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md)>;	Update the connector last sync stats. Update the fields related to the last sync of a connector. This action is used for analytics and monitoring.
lastSync	lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md), unknown>>;
lastSync	lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md)>;
list	list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorListResponse](./ConnectorListResponse.md)>;	Get all connectors. Get information about all connectors.
list	list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorListResponse](./ConnectorListResponse.md), unknown>>;
list	list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorListResponse](./ConnectorListResponse.md)>;
post	post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorPostResponse](./ConnectorPostResponse.md)>;	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.
post	post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorPostResponse](./ConnectorPostResponse.md), unknown>>;
post	post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorPostResponse](./ConnectorPostResponse.md)>;
put	put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorPutResponse](./ConnectorPutResponse.md)>;	Create or update a connector.
put	put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorPutResponse](./ConnectorPutResponse.md), unknown>>;
put	put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorPutResponse](./ConnectorPutResponse.md)>;
secretDelete	secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;	Deletes a connector secret.
secretDelete	secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;
secretDelete	secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;
secretGet	secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;	Retrieves a secret stored by Connectors.
secretGet	secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;
secretGet	secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;
secretPost	secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;	Creates a secret for a Connector.
secretPost	secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;
secretPost	secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;
secretPut	secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;	Creates or updates a secret for a Connector.
secretPut	secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;
secretPut	secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;
syncJobCancel	syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md)>;	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.
syncJobCancel	syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md), unknown>>;
syncJobCancel	syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md)>;
syncJobCheckIn	syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md)>;	Check in a connector sync job. Check in a connector sync job and set the last_seen field to the current time before updating it in the internal index. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
syncJobCheckIn	syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md), unknown>>;
syncJobCheckIn	syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md)>;
syncJobClaim	syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md)>;	Claim a connector sync job. This action updates the job status to in_progress and sets the last_seen and started_at timestamps to the current time. Additionally, it can set the sync_cursor property for the sync job. This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
syncJobClaim	syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md), unknown>>;
syncJobClaim	syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md)>;
syncJobDelete	syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md)>;	Delete a connector sync job. Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.
syncJobDelete	syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md), unknown>>;
syncJobDelete	syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md)>;
syncJobError	syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md)>;	Set a connector sync job error. Set the error field for a connector sync job and set its status to error. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
syncJobError	syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md), unknown>>;
syncJobError	syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md)>;
syncJobGet	syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md)>;	Get a connector sync job.
syncJobGet	syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md), unknown>>;
syncJobGet	syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md)>;
syncJobList	syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md)>;	Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order.
syncJobList	syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md), unknown>>;
syncJobList	syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md)>;
syncJobPost	syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md)>;	Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.
syncJobPost	syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md), unknown>>;
syncJobPost	syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md)>;
syncJobUpdateStats	syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md)>;	Set the connector sync job stats. Stats include: deleted_document_count, indexed_document_count, indexed_document_volume, and total_document_count. You can also update last_seen. This API is mainly used by the connector service for updating sync job information. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
syncJobUpdateStats	syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md), unknown>>;
syncJobUpdateStats	syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md)>;
updateActiveFiltering	updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md)>;	Activate the connector draft filter. Activates the valid draft filtering for a connector.
updateActiveFiltering	updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md), unknown>>;
updateActiveFiltering	updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md)>;
updateApiKeyId	updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md)>;	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.
updateApiKeyId	updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md), unknown>>;
updateApiKeyId	updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md)>;
updateConfiguration	updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md)>;	Update the connector configuration. Update the configuration field in the connector document.
updateConfiguration	updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md), unknown>>;
updateConfiguration	updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md)>;
updateError	updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md)>;	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.
updateError	updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md), unknown>>;
updateError	updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md)>;
updateFeatures	updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md)>;	Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector: * document-level security * incremental syncs * advanced sync rules * basic sync rules Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
updateFeatures	updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md), unknown>>;
updateFeatures	updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md)>;
updateFiltering	updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md)>;	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.
updateFiltering	updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md), unknown>>;
updateFiltering	updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md)>;
updateFilteringValidation	updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md)>;	Update the connector draft filtering validation. Update the draft filtering validation info for a connector.
updateFilteringValidation	updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md), unknown>>;
updateFilteringValidation	updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md)>;
updateIndexName	updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md)>;	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.
updateIndexName	updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md), unknown>>;
updateIndexName	updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md)>;
updateName	updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md)>;	Update the connector name and description.
updateName	updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md), unknown>>;
updateName	updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md)>;
updateNative	updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md)>;	Update the connector is_native flag.
updateNative	updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md), unknown>>;
updateNative	updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md)>;
updatePipeline	updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md)>;	Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings.
updatePipeline	updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md), unknown>>;
updatePipeline	updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md)>;
updateScheduling	updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md)>;	Update the connector scheduling.
updateScheduling	updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md), unknown>>;
updateScheduling	updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md)>;
updateServiceType	updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md)>;	Update the connector service type.
updateServiceType	updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md), unknown>>;
updateServiceType	updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md)>;
updateStatus	updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md)>;	Update the connector status.
updateStatus	updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md), unknown>>;
updateStatus	updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md)>;