Ingestion API client

This client is new in v3 of the Kotlin API clients.

The Ingestion API client is part of the algoliasearch-scala package. You can add this package to your build.gradle.kts file:

Copy
implementation("com.algolia:algoliasearch-client-kotlin:3.26.0")
// You also need to add a KTOR engine as dependency, for example:
implementation("io.ktor:ktor-client-java:$ktor_version")

To use the Ingestion client, add this import to your files:

Copy

1
2
3
import com.algolia.client.api.IngestionClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*

To create an instance of the client:

Copy

1
val client = IngestionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY", region = "ALGOLIA_APPLICATION_REGION")

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or eu for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

List of methods

Each method makes one request to the Ingestion API.

Tasks

client.push	Push records by indexName
client.listTasks	List tasks
client.createTask	Create a task
client.searchTasks	Search for tasks
client.getTask	Retrieve a task
client.updateTask	Update a task
client.deleteTask	Delete a task
client.runTask	Run a task
client.pushTask	Push records by taskID
client.enableTask	Enable a task
client.disableTask	Disable a task
client.listTasksV1	List tasks V1
client.createTaskV1	Create a task V1
client.searchTasksV1	Search for tasks V1
client.getTaskV1	Retrieve a task V1
client.updateTaskV1	Update a task V1
client.deleteTaskV1	Delete a task
client.runTaskV1	Run a task V1
client.enableTaskV1	Enable a task V1
client.disableTaskV1	Disable a task V1

Authentications

client.listAuthentications	List authentication resources
client.createAuthentication	Create an authentication resource
client.searchAuthentications	Search for authentication resources
client.getAuthentication	Retrieve an authentication resource
client.updateAuthentication	Update an authentication resource
client.deleteAuthentication	Delete an authentication resource

Destinations

client.listDestinations	List destinations
client.createDestination	Create a destination
client.searchDestinations	Search for destinations
client.getDestination	Retrieve a destination
client.updateDestination	Update a destination
client.deleteDestination	Delete a destination

Sources

client.listSources	List sources
client.createSource	Create a source
client.validateSource	Validates a source payload
client.searchSources	Search for sources
client.getSource	Retrieve a source
client.updateSource	Update a source
client.deleteSource	Delete a source
client.validateSourceBeforeUpdate	Validates an update of a source payload
client.triggerDockerSourceDiscover	Trigger a stream-listing request
client.runSource	Run all tasks linked to a source

Transformations

client.listTransformations	List transformations
client.createTransformation	Create a transformation
client.tryTransformation	Try a transformation before creating it
client.searchTransformations	Search for transformations
client.getTransformation	Retrieve a transformation
client.updateTransformation	Update a transformation
client.deleteTransformation	Delete a transformation
client.tryTransformationBeforeUpdate	Try a transformation before updating it

Observability

client.listRuns	List task runs
client.getRun	Retrieve a task run
client.listEvents	List task run events
client.getEvent	Retrieve a task run event

Did you find this page helpful?