elasticsearch

Module connector

Source
Expand description

Connector APIs

The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index. To get started with Connector APIs, check out the tutorial.

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:

  • Native connectors are a managed service on Elastic Cloud
  • Connector clients are self-managed on your infrastructure

This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid.  

§Optional, experimental

This requires the experimental-apis feature. Can have breaking changes in future versions or might even be removed entirely.

Structs§

Connector
Namespace client for Connector APIs  
ConnectorCheckIn
Builder for the Connector Check In API
ConnectorDelete
Builder for the Connector Delete API
ConnectorGet
Builder for the Connector Get API
ConnectorLastSync
Builder for the Connector Last Sync API
ConnectorList
Builder for the Connector List API
ConnectorPost
Builder for the Connector Post API
ConnectorPut
Builder for the Connector Put API
ConnectorSecretDelete
Builder for the Connector Secret Delete API
ConnectorSecretGet
Builder for the Connector Secret Get API
ConnectorSecretPost
Builder for the Connector Secret Post API
ConnectorSecretPut
Builder for the Connector Secret Put API
ConnectorSyncJobCancel
Builder for the Connector Sync Job Cancel API
ConnectorSyncJobCheckIn
Builder for the Connector Sync Job Check In API
ConnectorSyncJobClaim
Builder for the Connector Sync Job Claim API
ConnectorSyncJobDelete
Builder for the Connector Sync Job Delete API
ConnectorSyncJobError
Builder for the Connector Sync Job Error API
ConnectorSyncJobGet
Builder for the Connector Sync Job Get API
ConnectorSyncJobList
Builder for the Connector Sync Job List API
ConnectorSyncJobPost
Builder for the Connector Sync Job Post API
ConnectorSyncJobUpdateStats
Builder for the Connector Sync Job Update Stats API
ConnectorUpdateActiveFiltering
Builder for the Connector Update Active Filtering API
ConnectorUpdateApiKeyId
Builder for the Connector Update Api Key Id API
ConnectorUpdateConfiguration
Builder for the Connector Update Configuration API
ConnectorUpdateError
Builder for the Connector Update Error API
ConnectorUpdateFeatures
Builder for the Connector Update Features API
ConnectorUpdateFiltering
Builder for the Connector Update Filtering API
ConnectorUpdateFilteringValidation
Builder for the Connector Update Filtering Validation API
ConnectorUpdateIndexName
Builder for the Connector Update Index Name API
ConnectorUpdateName
Builder for the Connector Update Name API
ConnectorUpdateNative
Builder for the Connector Update Native API
ConnectorUpdatePipeline
Builder for the Connector Update Pipeline API
ConnectorUpdateScheduling
Builder for the Connector Update Scheduling API
ConnectorUpdateServiceType
Builder for the Connector Update Service Type API
ConnectorUpdateStatus
Builder for the Connector Update Status API

Enums§

ConnectorCheckInParts
API parts for the Connector Check In API
ConnectorDeleteParts
API parts for the Connector Delete API
ConnectorGetParts
API parts for the Connector Get API
ConnectorLastSyncParts
API parts for the Connector Last Sync API
ConnectorListParts
API parts for the Connector List API
ConnectorPostParts
API parts for the Connector Post API
ConnectorPutParts
API parts for the Connector Put API
ConnectorSecretDeleteParts
API parts for the Connector Secret Delete API
ConnectorSecretGetParts
API parts for the Connector Secret Get API
ConnectorSecretPostParts
API parts for the Connector Secret Post API
ConnectorSecretPutParts
API parts for the Connector Secret Put API
ConnectorSyncJobCancelParts
API parts for the Connector Sync Job Cancel API
ConnectorSyncJobCheckInParts
API parts for the Connector Sync Job Check In API
ConnectorSyncJobClaimParts
API parts for the Connector Sync Job Claim API
ConnectorSyncJobDeleteParts
API parts for the Connector Sync Job Delete API
ConnectorSyncJobErrorParts
API parts for the Connector Sync Job Error API
ConnectorSyncJobGetParts
API parts for the Connector Sync Job Get API
ConnectorSyncJobListParts
API parts for the Connector Sync Job List API
ConnectorSyncJobPostParts
API parts for the Connector Sync Job Post API
ConnectorSyncJobUpdateStatsParts
API parts for the Connector Sync Job Update Stats API
ConnectorUpdateActiveFilteringParts
API parts for the Connector Update Active Filtering API
ConnectorUpdateApiKeyIdParts
API parts for the Connector Update Api Key Id API
ConnectorUpdateConfigurationParts
API parts for the Connector Update Configuration API
ConnectorUpdateErrorParts
API parts for the Connector Update Error API
ConnectorUpdateFeaturesParts
API parts for the Connector Update Features API
ConnectorUpdateFilteringParts
API parts for the Connector Update Filtering API
ConnectorUpdateFilteringValidationParts
API parts for the Connector Update Filtering Validation API
ConnectorUpdateIndexNameParts
API parts for the Connector Update Index Name API
ConnectorUpdateNameParts
API parts for the Connector Update Name API
ConnectorUpdateNativeParts
API parts for the Connector Update Native API
ConnectorUpdatePipelineParts
API parts for the Connector Update Pipeline API
ConnectorUpdateSchedulingParts
API parts for the Connector Update Scheduling API
ConnectorUpdateServiceTypeParts
API parts for the Connector Update Service Type API
ConnectorUpdateStatusParts
API parts for the Connector Update Status API