algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.api/IngestionClient

IngestionClient

algoliasearch.api.IngestionClient
See theIngestionClient companion object
class IngestionClient(appId: String, apiKey: String, region: String, clientOptions: ClientOptions) extends ApiClient

Attributes

Companion
object
Graph
Supertypes
class ApiClient
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def createAuthentication(authenticationCreate: AuthenticationCreate, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[AuthenticationCreateResponse]

Creates a new authentication resource.

Creates a new authentication resource.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Attributes

def createDestination(destinationCreate: DestinationCreate, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DestinationCreateResponse]

Creates a new destination.

Creates a new destination.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Attributes

def createSource(sourceCreate: SourceCreate, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[SourceCreateResponse]

Creates a new source.

Creates a new source.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Attributes

def createTask(taskCreate: TaskCreate, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[TaskCreateResponse]

Creates a new task.

Creates a new task.

Value parameters

taskCreate

Request body for creating a task.

Attributes

def customDelete[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customGet[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$2: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPost[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$3: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPut[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$4: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def deleteAuthentication(authenticationID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DeleteResponse]

Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.

Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

authenticationID

Unique identifier of an authentication resource.

Attributes

def deleteDestination(destinationID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DeleteResponse]

Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.

Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

destinationID

Unique identifier of a destination.

Attributes

def deleteSource(sourceID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DeleteResponse]

Deletes a source by its ID. You can't delete sources that are referenced in tasks.

Deletes a source by its ID. You can't delete sources that are referenced in tasks.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

sourceID

Unique identifier of a source.

Attributes

def deleteTask(taskID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DeleteResponse]

Deletes a task by its ID.

Deletes a task by its ID.

Value parameters

taskID

Unique identifier of a task.

Attributes

def disableTask(taskID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[TaskUpdateResponse]

Disables a task.

Disables a task.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

taskID

Unique identifier of a task.

Attributes

def enableTask(taskID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[TaskUpdateResponse]

Enables a task.

Enables a task.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

taskID

Unique identifier of a task.

Attributes

def getAuthentication(authenticationID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Authentication]

Retrieves an authentication resource by its ID.

Retrieves an authentication resource by its ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

authenticationID

Unique identifier of an authentication resource.

Attributes

def getAuthentications(itemsPerPage: Option[Int], page: Option[Int], `type`: Option[Seq[AuthenticationType]], platform: Option[Seq[PlatformWithNone]], sort: Option[AuthenticationSortKeys], order: Option[OrderKeys], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ListAuthenticationsResponse]

Retrieves a list of all authentication resources.

Retrieves a list of all authentication resources.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

`type`

Type of authentication resource to retrieve.

itemsPerPage

Number of items per page.

order

Sort order of the response, ascending or descending.

page

Page number of the paginated API response.

platform

Ecommerce platform for which to retrieve authentication resources.

sort

Property by which to sort the list of authentication resources.

Attributes

def getDestination(destinationID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Destination]

Retrieves a destination by its ID.

Retrieves a destination by its ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

destinationID

Unique identifier of a destination.

Attributes

def getDestinations(itemsPerPage: Option[Int], page: Option[Int], `type`: Option[Seq[DestinationType]], authenticationID: Option[Seq[String]], sort: Option[DestinationSortKeys], order: Option[OrderKeys], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ListDestinationsResponse]

Retrieves a list of destinations.

Retrieves a list of destinations.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

`type`

Destination type.

authenticationID

Authentication ID used by destinations.

itemsPerPage

Number of items per page.

order

Sort order of the response, ascending or descending.

page

Page number of the paginated API response.

sort

Property by which to sort the destinations.

Attributes

def getDockerSourceStreams(sourceID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DockerSourceStreams]

Retrieves a stream listing for a source. Listing streams only works with sources with type: docker and imageType: singer.

Retrieves a stream listing for a source. Listing streams only works with sources with type: docker and imageType: singer.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

sourceID

Unique identifier of a source.

Attributes

def getEvent(runID: String, eventID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Event]

Retrieves a single task run event by its ID.

Retrieves a single task run event by its ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

eventID

Unique identifier of an event.

runID

Unique identifier of a task run.

Attributes

def getEvents(runID: String, itemsPerPage: Option[Int], page: Option[Int], status: Option[Seq[EventStatus]], `type`: Option[Seq[EventType]], sort: Option[EventSortKeys], order: Option[OrderKeys], startDate: Option[String], endDate: Option[String], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ListEventsResponse]

Retrieves a list of events for a task run, identified by it's ID.

Retrieves a list of events for a task run, identified by it's ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

`type`

Event type for filtering the list of task runs.

endDate

Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.

itemsPerPage

Number of items per page.

order

Sort order of the response, ascending or descending.

page

Page number of the paginated API response.

runID

Unique identifier of a task run.

sort

Property by which to sort the list of task run events.

startDate

Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.

status

Event status for filtering the list of task runs.

Attributes

def getRun(runID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Run]

Retrieve a single task run by its ID.

Retrieve a single task run by its ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

runID

Unique identifier of a task run.

Attributes

def getRuns(itemsPerPage: Option[Int], page: Option[Int], status: Option[Seq[RunStatus]], taskID: Option[String], sort: Option[RunSortKeys], order: Option[OrderKeys], startDate: Option[String], endDate: Option[String], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[RunListResponse]

Retrieve a list of task runs.

Retrieve a list of task runs.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

endDate

Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.

itemsPerPage

Number of items per page.

order

Sort order of the response, ascending or descending.

page

Page number of the paginated API response.

sort

Property by which to sort the list of task runs.

startDate

Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.

status

Run status for filtering the list of task runs.

taskID

Task ID for filtering the list of task runs.

Attributes

def getSource(sourceID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Source]

Retrieve a source by its ID.

Retrieve a source by its ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

sourceID

Unique identifier of a source.

Attributes

def getSources(itemsPerPage: Option[Int], page: Option[Int], `type`: Option[Seq[SourceType]], authenticationID: Option[Seq[String]], sort: Option[SourceSortKeys], order: Option[OrderKeys], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ListSourcesResponse]

Retrieves a list of sources.

Retrieves a list of sources.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

`type`

Source type. Some sources require authentication.

authenticationID

Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication resource.

itemsPerPage

Number of items per page.

order

Sort order of the response, ascending or descending.

page

Page number of the paginated API response.

sort

Property by which to sort the list of sources.

Attributes

def getTask(taskID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Task]

Retrieves a task by its ID.

Retrieves a task by its ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

taskID

Unique identifier of a task.

Attributes

def getTasks(itemsPerPage: Option[Int], page: Option[Int], action: Option[Seq[ActionType]], enabled: Option[Boolean], sourceID: Option[Seq[String]], destinationID: Option[Seq[String]], triggerType: Option[Seq[TriggerType]], sort: Option[TaskSortKeys], order: Option[OrderKeys], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[ListTasksResponse]

Retrieves a list of tasks.

Retrieves a list of tasks.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

action

Actions for filtering the list of tasks.

destinationID

Destination IDs for filtering the list of tasks.

enabled

Whether to filter the list of tasks by the enabled status.

itemsPerPage

Number of items per page.

order

Sort order of the response, ascending or descending.

page

Page number of the paginated API response.

sort

Property by which to sort the list of tasks.

sourceID

Source IDs for filtering the list of tasks.

triggerType

Type of task trigger for filtering the list of tasks.

Attributes

def runTask(taskID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[RunResponse]

Runs a task. You can check the status of task runs with the observability endpoints.

Runs a task. You can check the status of task runs with the observability endpoints.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

taskID

Unique identifier of a task.

Attributes

def searchAuthentications(authenticationSearch: AuthenticationSearch, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Seq[Authentication]]

Searches for authentication resources.

Searches for authentication resources.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Attributes

def searchDestinations(destinationSearch: DestinationSearch, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Seq[Destination]]

Searches for destinations.

Searches for destinations.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Attributes

def searchSources(sourceSearch: SourceSearch, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Seq[Source]]

Searches for sources.

Searches for sources.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Attributes

def searchTasks(taskSearch: TaskSearch, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[Seq[Task]]

Searches for tasks.

Searches for tasks.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Attributes

def triggerDockerSourceDiscover(sourceID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DockerSourceDiscover]

Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with type: docker and imageType: singer.

Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with type: docker and imageType: singer.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

sourceID

Unique identifier of a source.

Attributes

def updateAuthentication(authenticationID: String, authenticationUpdate: AuthenticationUpdate, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[AuthenticationUpdateResponse]

Updates an authentication resource.

Updates an authentication resource.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

authenticationID

Unique identifier of an authentication resource.

Attributes

def updateDestination(destinationID: String, destinationUpdate: DestinationUpdate, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DestinationUpdateResponse]

Updates the destination by its ID.

Updates the destination by its ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

destinationID

Unique identifier of a destination.

Attributes

def updateSource(sourceID: String, sourceUpdate: SourceUpdate, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[SourceUpdateResponse]

Updates a source by its ID.

Updates a source by its ID.

Required API Key ACLs:

  • addObject
  • deleteIndex
  • editSettings

Value parameters

sourceID

Unique identifier of a source.

Attributes

def updateTask(taskID: String, taskUpdate: TaskUpdate, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[TaskUpdateResponse]

Updates a task by its ID.

Updates a task by its ID.

Value parameters

taskID

Unique identifier of a task.

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient
Generated with