Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Create a authentication.
Create a authentication.
Attributes
Create a destination.
Create a destination.
Attributes
Create a source.
Create a source.
Attributes
Create a task.
Create a task.
Attributes
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
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
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
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
Soft delete the authentication of the given authenticationID.
Soft delete the authentication of the given authenticationID.
Value parameters
- authenticationID
-
The authentication UUID.
Attributes
Soft delete the destination of the given destinationID.
Soft delete the destination of the given destinationID.
Value parameters
- destinationID
-
The destination UUID.
Attributes
Soft delete the source of the given sourceID.
Soft delete the source of the given sourceID.
Value parameters
- sourceID
-
The source UUID.
Attributes
Soft delete the task of the given taskID.
Soft delete the task of the given taskID.
Value parameters
- taskID
-
The task UUID.
Attributes
Disable the task of the given taskID.
Disable the task of the given taskID.
Value parameters
- taskID
-
The task UUID.
Attributes
Enable the task of the given taskID.
Enable the task of the given taskID.
Value parameters
- taskID
-
The task UUID.
Attributes
Get the authentication of the given authenticationID.
Get the authentication of the given authenticationID.
Value parameters
- authenticationID
-
The authentication UUID.
Attributes
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
Get the destination of the given destinationID.
Get the destination of the given destinationID.
Value parameters
- destinationID
-
The destination UUID.
Attributes
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
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
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
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
Get a single run for the given ID.
Get a single run for the given ID.
Value parameters
- runID
-
The run UUID.
Attributes
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
Get the source of the given sourceID.
Get the source of the given sourceID.
Value parameters
- sourceID
-
The source UUID.
Attributes
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
Get the task of the given taskID.
Get the task of the given taskID.
Value parameters
- taskID
-
The task UUID.
Attributes
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
Run the task of the given taskID.
Run the task of the given taskID.
Value parameters
- taskID
-
The task UUID.
Attributes
Search among authentications with a defined set of parameters.
Search among authentications with a defined set of parameters.
Attributes
Search among destinations with a defined set of parameters.
Search among destinations with a defined set of parameters.
Attributes
Search among sources with a defined set of parameters.
Search among sources with a defined set of parameters.
Attributes
Search among tasks with a defined set of parameters.
Search among tasks with a defined set of parameters.
Attributes
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
Update the authentication of the given authenticationID.
Update the authentication of the given authenticationID.
Value parameters
- authenticationID
-
The authentication UUID.
Attributes
Update the destination of the given destinationID.
Update the destination of the given destinationID.
Value parameters
- destinationID
-
The destination UUID.
Attributes
Update the source of the given sourceID.
Update the source of the given sourceID.
Value parameters
- sourceID
-
The source UUID.
Attributes
Update the task of the given taskID.
Update the task of the given taskID.
Value parameters
- taskID
-
The task UUID.