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]

Create a authentication.

Create a authentication.

Attributes

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

Create a destination.

Create a destination.

Attributes

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

Create a source.

Create a source.

Attributes

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

Create a task.

Create 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]

Soft delete the authentication of the given authenticationID.

Soft delete the authentication of the given authenticationID.

Value parameters

authenticationID

The authentication UUID.

Attributes

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

Soft delete the destination of the given destinationID.

Soft delete the destination of the given destinationID.

Value parameters

destinationID

The destination UUID.

Attributes

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

Soft delete the source of the given sourceID.

Soft delete the source of the given sourceID.

Value parameters

sourceID

The source UUID.

Attributes

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

Soft delete the task of the given taskID.

Soft delete the task of the given taskID.

Value parameters

taskID

The task UUID.

Attributes

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

Disable the task of the given taskID.

Disable the task of the given taskID.

Value parameters

taskID

The task UUID.

Attributes

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

Enable the task of the given taskID.

Enable the task of the given taskID.

Value parameters

taskID

The task UUID.

Attributes

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

Get the authentication of the given authenticationID.

Get the authentication of the given authenticationID.

Value parameters

authenticationID

The authentication UUID.

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]

Get a list of authentications for the given query parameters, with pagination details.

Get a list of authentications for the given query parameters, with pagination details.

Value parameters

`type`

The type of the authentications to retrieve.

itemsPerPage

The number of items per page to return.

order

The order of the returned list.

page

The page number to fetch, starting at 1.

platform

The platform of the authentications to retrieve.

sort

The key by which the list should be sorted.

Attributes

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

Get the destination of the given destinationID.

Get the destination of the given destinationID.

Value parameters

destinationID

The destination UUID.

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]

Get a list of destinations for the given query parameters, with pagination details.

Get a list of destinations for the given query parameters, with pagination details.

Value parameters

`type`

The type of the destinations to retrive.

authenticationID

The authenticationIDs of the destinations to retrive.

itemsPerPage

The number of items per page to return.

order

The order of the returned list.

page

The page number to fetch, starting at 1.

sort

The key by which the list should be sorted.

Attributes

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

Retrieve a stream listing for a given Singer specification compatible docker type source ID.

Retrieve a stream listing for a given Singer specification compatible docker type source ID.

Value parameters

sourceID

The source UUID.

Attributes

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

Get a single event for a specific runID.

Get a single event for a specific runID.

Value parameters

eventID

The event UUID.

runID

The run UUID.

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]

Get a list of events associated to the given runID, for the given query parameters.

Get a list of events associated to the given runID, for the given query parameters.

Value parameters

`type`

Filter the type of the events.

endDate

The end date (in RFC3339 format) of the events fetching window. Defaults to 'now' days if omitted.

itemsPerPage

The number of items per page to return.

order

The order of the returned list.

page

The page number to fetch, starting at 1.

runID

The run UUID.

sort

The key by which the list should be sorted.

startDate

The start date (in RFC3339 format) of the events fetching window. Defaults to 'now'-3 hours if omitted.

status

Filter the status of the events.

Attributes

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

Get a single run for the given ID.

Get a single run for the given ID.

Value parameters

runID

The run UUID.

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]

Get a list of runs for the given query parameters, with pagination details.

Get a list of runs for the given query parameters, with pagination details.

Value parameters

endDate

The end date (in RFC3339 format) of the runs fetching window. Defaults to 'now' days if omitted.

itemsPerPage

The number of items per page to return.

order

The order of the returned list.

page

The page number to fetch, starting at 1.

sort

The key by which the list should be sorted.

startDate

The start date (in RFC3339 format) of the runs fetching window. Defaults to 'now'-7 days if omitted.

status

Filter the status of the runs.

taskID

Filter by taskID.

Attributes

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

Get the source of the given sourceID.

Get the source of the given sourceID.

Value parameters

sourceID

The source UUID.

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]

Get a list of sources for the given query parameters, with pagination details.

Get a list of sources for the given query parameters, with pagination details.

Value parameters

`type`

The type of the sources to retrieve.

authenticationID

The authenticationIDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication.

itemsPerPage

The number of items per page to return.

order

The order of the returned list.

page

The page number to fetch, starting at 1.

sort

The key by which the list should be sorted.

Attributes

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

Get the task of the given taskID.

Get the task of the given taskID.

Value parameters

taskID

The task UUID.

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]

Get a list of tasks for the given query parameters, with pagination details.

Get a list of tasks for the given query parameters, with pagination details.

Value parameters

action

The action of the tasks to retrieve.

destinationID

The destinationIDs of the tasks to retrive.

enabled

Whether the task is enabled or not.

itemsPerPage

The number of items per page to return.

order

The order of the returned list.

page

The page number to fetch, starting at 1.

sort

The key by which the list should be sorted.

sourceID

The sourceIDs of the tasks to retrive.

triggerType

The trigger type of the task.

Attributes

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

Run the task of the given taskID.

Run the task of the given taskID.

Value parameters

taskID

The task UUID.

Attributes

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

Search among authentications with a defined set of parameters.

Search among authentications with a defined set of parameters.

Attributes

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

Search among destinations with a defined set of parameters.

Search among destinations with a defined set of parameters.

Attributes

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

Search among sources with a defined set of parameters.

Search among sources with a defined set of parameters.

Attributes

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

Search among tasks with a defined set of parameters.

Search among tasks with a defined set of parameters.

Attributes

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

Trigger a stream listing request for a Singer specification compatible docker type source.

Trigger a stream listing request for a Singer specification compatible docker type source.

Value parameters

sourceID

The source UUID.

Attributes

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

Update the authentication of the given authenticationID.

Update the authentication of the given authenticationID.

Value parameters

authenticationID

The authentication UUID.

Attributes

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

Update the destination of the given destinationID.

Update the destination of the given destinationID.

Value parameters

destinationID

The destination UUID.

Attributes

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

Update the source of the given sourceID.

Update the source of the given sourceID.

Value parameters

sourceID

The source UUID.

Attributes

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

Update the task of the given taskID.

Update the task of the given taskID.

Value parameters

taskID

The task UUID.

Attributes

Inherited methods

override def close(): Unit

Attributes

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