Sep 20, 2024
Ingestion API client
This client is new in v2 of the Scala API clients.
The Ingestion API client is part of the algoliasearch-scala
package.
You can add this package to your build.sbt
file:
Copy
1
2
3
4
// For Scala 3:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_3" % "2.7.0"
// For Scala 2:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_2" % "2.7.0"
To use the Ingestion client, add these imports to your files:
Copy
1
import algoliasearch.api.IngestionClient
To create an instance of the client:
Copy
1
2
3
4
5
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.
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 |
Tasks
client.listTasksV1 | List tasks |
client.createTaskV1 | Create a task |
client.searchTasksV1 | Search for tasks |
client.getTaskV1 | Retrieve a task |
client.updateTaskV1 | Update a task |
client.deleteTaskV1 | Delete a task |
client.runTaskV1 | Run a task |
client.enableTaskV1 | Enable a task |
client.disableTaskV1 | Disable a task |
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 a `batch` request payload through the Pipeline |
client.enableTask | Enable a task |
client.disableTask | Disable a task |
Transformations
client.listTransformations | List transformations |
client.createTransformation | Create a transformation |
client.tryTransformation | Try a transformation |
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 |
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?