algoliasearch.ingestion
Members list
Type members
Classlikes
The action to perform on the Algolia index.
The action to perform on the Algolia index.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ActionType.type
Attributes
- Supertypes
-
class CustomSerializer[ActionType]trait Serializer[ActionType]class Objecttrait Matchableclass Any
Authentication input used for token credentials.
Authentication input used for token credentials.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputTraittrait AuthInputclass Objecttrait Matchableclass AnyShow all
Authentication input used for token credentials.
Authentication input used for token credentials.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputPartialTraittrait AuthInputPartialclass Objecttrait Matchableclass AnyShow all
AuthAlgolia
AuthAlgolia
Value parameters
- apiKey
-
Algolia API Key, with the correct rights to push to an index and change settings.
- appID
-
Algolia Application ID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputTraittrait AuthInputclass Objecttrait Matchableclass AnyShow all
AuthAlgoliaPartial
AuthAlgoliaPartial
Value parameters
- apiKey
-
Algolia API Key, with the correct rights to push to an index and change settings.
- appID
-
Algolia Application ID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputPartialTraittrait AuthInputPartialclass Objecttrait Matchableclass AnyShow all
Authentication input for Basic login with username and password.
Authentication input for Basic login with username and password.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputTraittrait AuthInputclass Objecttrait Matchableclass AnyShow all
Authentication input for Basic login with username and password.
Authentication input for Basic login with username and password.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputPartialTraittrait AuthInputPartialclass Objecttrait Matchableclass AnyShow all
Authentication input to connect to a Google service (e.g. BigQuery).
Authentication input to connect to a Google service (e.g. BigQuery).
Value parameters
- clientEmail
-
Email address of the Service Account.
- privateKey
-
Private key of the Service Account.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputTraittrait AuthInputclass Objecttrait Matchableclass AnyShow all
Authentication input to connect to a Google service (e.g. BigQuery).
Authentication input to connect to a Google service (e.g. BigQuery).
Value parameters
- clientEmail
-
Email address of the Service Account.
- privateKey
-
Private key of the Service Account.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputPartialTraittrait AuthInputPartialclass Objecttrait Matchableclass AnyShow all
AuthInput
AuthInput
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait AuthInputTraitclass AuthAPIKeyclass AuthAlgoliaclass AuthBasicclass AuthGoogleServiceAccountclass AuthOAuthShow all
AuthInputPartial
AuthInputPartial
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait AuthInputPartialTraitclass AuthAPIKeyPartialclass AuthAlgoliaPartialclass AuthBasicPartialclass AuthOAuthPartialShow all
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
AuthInputPartial.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
Attributes
- Supertypes
- Self type
-
AuthInputSerializer.type
Attributes
- Supertypes
- Known subtypes
Authentication input for OAuth login.
Authentication input for OAuth login.
Value parameters
- client_id
-
The clientID.
- client_secret
-
The secret.
- url
-
The OAuth endpoint URL.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputTraittrait AuthInputclass Objecttrait Matchableclass AnyShow all
Authentication input for OAuth login.
Authentication input for OAuth login.
Value parameters
- client_id
-
The clientID.
- client_secret
-
The secret.
- url
-
The OAuth endpoint URL.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthInputPartialTraittrait AuthInputPartialclass Objecttrait Matchableclass AnyShow all
An authentication is used to login into a Source or a Destination.
An authentication is used to login into a Source or a Destination.
Value parameters
- authenticationID
-
The authentication UUID.
- createdAt
-
Date of creation (RFC3339 format).
- name
-
An human readable name describing the object.
- updatedAt
-
Date of last update (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The payload when creating an authentication.
The payload when creating an authentication.
Value parameters
- name
-
An human readable name describing the object.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Response from the API when the Authentication is successfully created.
Response from the API when the Authentication is successfully created.
Value parameters
- authenticationID
-
The authentication UUID.
- createdAt
-
Date of creation (RFC3339 format).
- name
-
An human readable name describing the object.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Payload to search for multiple authentications, based on the given authenticationIDs
.
Payload to search for multiple authentications, based on the given authenticationIDs
.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Used to sort the Authentication list endpoint.
Used to sort the Authentication list endpoint.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
class CustomSerializer[AuthenticationSortKeys]trait Serializer[AuthenticationSortKeys]class Objecttrait Matchableclass Any
Type of the Authentication, defines what kind of object is stored in the input.
Type of the Authentication, defines what kind of object is stored in the input.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
AuthenticationType.type
Attributes
- Supertypes
-
class CustomSerializer[AuthenticationType]trait Serializer[AuthenticationType]class Objecttrait Matchableclass Any
Payload to partially update an Authentication.
Payload to partially update an Authentication.
Value parameters
- name
-
An human readable name describing the object.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Response from the API when the Authentication is successfully updated.
Response from the API when the Authentication is successfully updated.
Value parameters
- authenticationID
-
The authentication UUID.
- name
-
An human readable name describing the object.
- updatedAt
-
Date of last update (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BigCommerceChannel
BigCommerceChannel
Value parameters
- currencies
-
An array of currencies for the given channel
ID
, a currency is a trigram string that represents the currency code. - id
-
The ID of the bigcommerce channel.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BigCommerceMetafield
BigCommerceMetafield
Value parameters
- key
-
The key identifier of the metafield.
- namespace
-
The namespace of the metafield.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BigQueryDataType enumeration
BigQueryDataType enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
BigQueryDataType.type
Attributes
- Supertypes
-
class CustomSerializer[BigQueryDataType]trait Serializer[BigQueryDataType]class Objecttrait Matchableclass Any
DeleteResponse
DeleteResponse
Value parameters
- deletedAt
-
Date of deletion (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A destination describe how the data is indexed on the Algolia side.
A destination describe how the data is indexed on the Algolia side.
Value parameters
- createdAt
-
Date of creation (RFC3339 format).
- destinationID
-
The destination UUID.
- name
-
An human readable name describing the object.
- updatedAt
-
Date of last update (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The payload when creating a destination.
The payload when creating a destination.
Value parameters
- authenticationID
-
The authentication UUID.
- name
-
An human readable name describing the object.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Response from the API when the Destination is successfully created.
Response from the API when the Destination is successfully created.
Value parameters
- createdAt
-
Date of creation (RFC3339 format).
- destinationID
-
The destination UUID.
- name
-
An human readable name describing the object.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
DestinationIndexName
DestinationIndexName
Value parameters
- attributesToExclude
-
Determines the attributes to exclude from an Algolia record. To remove nested element, you can separate the path to the element with dots (
.
): - "foo.bar": will removebar
fromfoo
. To remove elements from an array, you can use the following: - "foo.[0].bar": will only removebar
from the first element offoo
. - "foo.[*].bar": will removebar
from every elements offoo
. - indexName
-
The index name to store data in.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait DestinationInputTraittrait DestinationInputclass Objecttrait Matchableclass AnyShow all
DestinationIndexPrefix
DestinationIndexPrefix
Value parameters
- indexPrefix
-
The prefix of the final index name.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait DestinationInputTraittrait DestinationInputclass Objecttrait Matchableclass AnyShow all
DestinationInput
DestinationInput
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
DestinationInput.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class DestinationIndexNameclass DestinationIndexPrefix
Payload to search for multiple destinations, based on the given destinationIDs
.
Payload to search for multiple destinations, based on the given destinationIDs
.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Used to sort the Destination list endpoint.
Used to sort the Destination list endpoint.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
DestinationSortKeys.type
Attributes
- Supertypes
-
class CustomSerializer[DestinationSortKeys]trait Serializer[DestinationSortKeys]class Objecttrait Matchableclass Any
Type of the Destination, defines in which Algolia product the data will be stored.
Type of the Destination, defines in which Algolia product the data will be stored.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
DestinationType.type
Attributes
- Supertypes
-
class CustomSerializer[DestinationType]trait Serializer[DestinationType]class Objecttrait Matchableclass Any
Payload to partially update a Destination.
Payload to partially update a Destination.
Value parameters
- name
-
An human readable name describing the object.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Response from the API when the Destination is successfully updated.
Response from the API when the Destination is successfully updated.
Value parameters
- destinationID
-
The destination UUID.
- name
-
An human readable name describing the object.
- updatedAt
-
Date of last update (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The type of the image.
The type of the image.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
DockerImageType.type
Attributes
- Supertypes
-
class CustomSerializer[DockerImageType]trait Serializer[DockerImageType]class Objecttrait Matchableclass Any
The registry where the image is stored.
The registry where the image is stored.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
DockerRegistry.type
Attributes
- Supertypes
-
class CustomSerializer[DockerRegistry]trait Serializer[DockerRegistry]class Objecttrait Matchableclass Any
DockerSourceDiscover
DockerSourceDiscover
Value parameters
- createdAt
-
Date of creation (RFC3339 format).
- runID
-
The run UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
DockerSourceStreams
DockerSourceStreams
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Error.
Error.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
An event describe a step of the task execution flow..
An event describe a step of the task execution flow..
Value parameters
- batchSize
-
The extracted record batch size.
- eventID
-
The event UUID.
- parentID
-
The parent event, the cause of this event.
- publishedAt
-
Date of publish (RFC3339 format).
- runID
-
The run UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Used to sort the Event list endpoint.
Used to sort the Event list endpoint.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
EventSortKeys.type
Attributes
- Supertypes
-
class CustomSerializer[EventSortKeys]trait Serializer[EventSortKeys]class Objecttrait Matchableclass Any
EventStatus enumeration
EventStatus enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
EventStatus.type
Attributes
- Supertypes
-
class CustomSerializer[EventStatus]trait Serializer[EventStatus]class Objecttrait Matchableclass Any
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
JsonSupport.type
ListAuthenticationsResponse
ListAuthenticationsResponse
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
ListDestinationsResponse
ListDestinationsResponse
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
ListEventsResponse
ListEventsResponse
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
ListSourcesResponse
ListSourcesResponse
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A list of tasks with pagination details.
A list of tasks with pagination details.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
MappingTypeCSV enumeration
MappingTypeCSV enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
MappingTypeCSV.type
Attributes
- Supertypes
-
class CustomSerializer[MappingTypeCSV]trait Serializer[MappingTypeCSV]class Objecttrait Matchableclass Any
MethodType enumeration
MethodType enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
MethodType.type
Attributes
- Supertypes
-
class CustomSerializer[MethodType]trait Serializer[MethodType]class Objecttrait Matchableclass Any
The input for an onDemand
task whose source is of type bigquery
and for which extracted data spans a given time range.
The input for an onDemand
task whose source is of type bigquery
and for which extracted data spans a given time range.
Value parameters
- endDate
-
The end date of the extraction (RFC3339 format).
- startDate
-
The start date of the extraction (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait TaskInputTraittrait TaskInputclass Objecttrait Matchableclass AnyShow all
The trigger information of a task of type onDemand
.
The trigger information of a task of type onDemand
.
Value parameters
- lastRun
-
The last time the scheduled task ran (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait TriggerTraittrait Triggerclass Objecttrait Matchableclass AnyShow all
The trigger information of a task of type onDemand
.
The trigger information of a task of type onDemand
.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait TaskCreateTriggerTraittrait TaskCreateTriggerclass Objecttrait Matchableclass AnyShow all
A task which is manually executed via the run task endpoint.
A task which is manually executed via the run task endpoint.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
OnDemandTriggerType.type
Attributes
- Supertypes
-
class CustomSerializer[OnDemandTriggerType]trait Serializer[OnDemandTriggerType]class Objecttrait Matchableclass Any
Pagination
Pagination
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
- Known subtypes
-
object Bigcommerce.typeobject Commercetools.type
Attributes
Used to filter Authentication without platform property.
Used to filter Authentication without platform property.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
PlatformNone.type
Attributes
- Supertypes
-
class CustomSerializer[PlatformNone]trait Serializer[PlatformNone]class Objecttrait Matchableclass Any
PlatformWithNone
PlatformWithNone
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait PlatformWithNoneTraittrait Platformobject Bigcommerce.typeobject Commercetools.typetrait PlatformNoneobject None.typeShow all
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
PlatformWithNone.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
trait Platformobject Bigcommerce.typeobject Commercetools.typetrait PlatformNoneobject None.type
Determines the indexing strategy to use for a given e-commerce source.
Determines the indexing strategy to use for a given e-commerce source.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RecordType.type
Attributes
- Supertypes
-
class CustomSerializer[RecordType]trait Serializer[RecordType]class Objecttrait Matchableclass Any
Run
Run
Value parameters
- createdAt
-
Date of creation (RFC3339 format).
- failureThreshold
-
A percentage representing the accepted failure threshold to determine if a
run
succeeded or not. - finishedAt
-
Date of finish (RFC3339 format).
- reason
-
Explains the result of outcome.
- runID
-
The run UUID.
- startedAt
-
Date of start (RFC3339 format).
- taskID
-
The task UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
RunListResponse
RunListResponse
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
RunOutcome enumeration
RunOutcome enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RunOutcome.type
Attributes
- Supertypes
-
class CustomSerializer[RunOutcome]trait Serializer[RunOutcome]class Objecttrait Matchableclass Any
RunProgress
RunProgress
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
An identifier that pairs with the outcome reason.
An identifier that pairs with the outcome reason.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RunReasonCode.type
Attributes
- Supertypes
-
class CustomSerializer[RunReasonCode]trait Serializer[RunReasonCode]class Objecttrait Matchableclass Any
The response from the run task API, containing an Observability Run ID and the time it was created at.
The response from the run task API, containing an Observability Run ID and the time it was created at.
Value parameters
- createdAt
-
Date of creation (RFC3339 format).
- runID
-
The run UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Used to sort the Run list endpoint.
Used to sort the Run list endpoint.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RunSortKeys.type
Attributes
- Supertypes
-
class CustomSerializer[RunSortKeys]trait Serializer[RunSortKeys]class Objecttrait Matchableclass Any
The input for a schedule
task whose source is of type bigquery
and for which extracted data spans a fixed number of days.
The input for a schedule
task whose source is of type bigquery
and for which extracted data spans a fixed number of days.
Value parameters
- timeframe
-
The timeframe of the extraction, in number of days from today.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait TaskInputTraittrait TaskInputclass Objecttrait Matchableclass AnyShow all
The trigger information for a task of type 'schedule'.
The trigger information for a task of type 'schedule'.
Value parameters
- cron
-
A cron expression that represent at which regularity the task should run.
- lastRun
-
The last time the scheduled task ran (RFC3339 format).
- nextRun
-
The next scheduled run of the task (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait TriggerTraittrait Triggerclass Objecttrait Matchableclass AnyShow all
The trigger input for a task of type 'schedule'.
The trigger input for a task of type 'schedule'.
Value parameters
- cron
-
A cron expression that represent at which regularity the task should run.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait TaskCreateTriggerTraittrait TaskCreateTriggerclass Objecttrait Matchableclass AnyShow all
A task which is triggered by a schedule (cron expression).
A task which is triggered by a schedule (cron expression).
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ScheduleTriggerType.type
Attributes
- Supertypes
-
class CustomSerializer[ScheduleTriggerType]trait Serializer[ScheduleTriggerType]class Objecttrait Matchableclass Any
Source
Source
Value parameters
- authenticationID
-
The authentication UUID.
- createdAt
-
Date of creation (RFC3339 format).
- sourceID
-
The source UUID.
- updatedAt
-
Date of last update (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
SourceBigCommerce
SourceBigCommerce
Value parameters
- storeHash
-
The store hash identifying the store the shopper is signing in to.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SourceInputTraittrait SourceInputclass Objecttrait Matchableclass AnyShow all
SourceBigQuery
SourceBigQuery
Value parameters
- customSQLRequest
-
Custom SQL request to extract data from the BigQuery table.
- datasetID
-
Dataset ID of the BigQuery Source.
- projectID
-
Project ID of the BigQuery Source.
- table
-
Table name (for default BQ).
- tablePrefix
-
Table prefix (for Google Analytics).
- uniqueIDColumn
-
The name of the column that contains the unique ID, used as
objectID
in Algolia.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SourceInputTraittrait SourceInputtrait SourceUpdateInputTraittrait SourceUpdateInputclass Objecttrait Matchableclass AnyShow all
SourceCSV
SourceCSV
Value parameters
- delimiter
-
The character used to split the value on each line, default to a comma (\r, \n, 0xFFFD, and space are forbidden).
- mapping
-
Mapping of type for every column. For example {"myColumn": "boolean", "myOtherColumn": "json"}.
- uniqueIDColumn
-
The name of the column that contains the unique ID, used as
objectID
in Algolia. - url
-
The URL of the file.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SourceInputTraittrait SourceInputtrait SourceUpdateInputTraittrait SourceUpdateInputclass Objecttrait Matchableclass AnyShow all
SourceCommercetools
SourceCommercetools
Value parameters
- fallbackIsInStockValue
-
Determines the value that will be stored in the Algolia record if there's no inventory information on the product.
- locales
-
Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example ["fr-FR", "en"].
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SourceInputTraittrait SourceInputclass Objecttrait Matchableclass AnyShow all
SourceCreate
SourceCreate
Value parameters
- authenticationID
-
The authentication UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
SourceCreateResponse
SourceCreateResponse
Value parameters
- createdAt
-
Date of creation (RFC3339 format).
- sourceID
-
The source UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
SourceDocker
SourceDocker
Value parameters
- configuration
-
The configuration of the spec.
- image
-
The name of the image to pull.
- version
-
The version of the image, defaults to
latest
.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SourceInputTraittrait SourceInputclass Objecttrait Matchableclass AnyShow all
SourceInput
SourceInput
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait SourceInputTraitclass SourceBigCommerceclass SourceBigQueryclass SourceCSVclass SourceCommercetoolsclass SourceDockerclass SourceJSONShow all
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
SourceInput.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class SourceBigCommerceclass SourceBigQueryclass SourceCSVclass SourceCommercetoolsclass SourceDockerclass SourceJSONShow all
SourceJSON
SourceJSON
Value parameters
- uniqueIDColumn
-
The name of the column that contains the unique ID, used as
objectID
in Algolia. - url
-
The URL of the file.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SourceInputTraittrait SourceInputtrait SourceUpdateInputTraittrait SourceUpdateInputclass Objecttrait Matchableclass AnyShow all
SourceSearch
SourceSearch
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Used to sort the Source list endpoint.
Used to sort the Source list endpoint.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
SourceSortKeys.type
Attributes
- Supertypes
-
class CustomSerializer[SourceSortKeys]trait Serializer[SourceSortKeys]class Objecttrait Matchableclass Any
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object Bigcommerce.typeobject Bigquery.typeobject Commercetools.typeobject Csv.typeobject Docker.typeobject Json.typeShow all
SourceType enumeration
SourceType enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
SourceType.type
Attributes
- Supertypes
-
class CustomSerializer[SourceType]trait Serializer[SourceType]class Objecttrait Matchableclass Any
SourceUpdate
SourceUpdate
Value parameters
- authenticationID
-
The authentication UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
SourceUpdateCommercetools
SourceUpdateCommercetools
Value parameters
- locales
-
Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example ["fr-FR", "en"].
- storeKeys
-
Unique and immutable key of the referenced Store.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SourceUpdateInputTraittrait SourceUpdateInputclass Objecttrait Matchableclass AnyShow all
SourceUpdateDocker
SourceUpdateDocker
Value parameters
- configuration
-
The configuration of the spec.
- image
-
The name of the image to pull.
- version
-
The version of the image, defaults to
latest
.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SourceUpdateInputTraittrait SourceUpdateInputclass Objecttrait Matchableclass AnyShow all
SourceUpdateInput
SourceUpdateInput
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait SourceUpdateInputTraitclass SourceBigQueryclass SourceCSVclass SourceJSONclass SourceUpdateDockerShow all
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
SourceUpdateInput.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
SourceUpdateResponse
SourceUpdateResponse
Value parameters
- sourceID
-
The source UUID.
- updatedAt
-
Date of last update (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The trigger input for a task of type 'subscription'.
The trigger input for a task of type 'subscription'.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait TaskCreateTriggerTraittrait TaskCreateTriggertrait TriggerTraittrait Triggerclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object Subscription.type
A task which is triggered by an external subscription (e.g. Webhook).
A task which is triggered by an external subscription (e.g. Webhook).
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
class CustomSerializer[SubscriptionTriggerType]trait Serializer[SubscriptionTriggerType]class Objecttrait Matchableclass Any
Task
Task
Value parameters
- createdAt
-
Date of creation (RFC3339 format).
- destinationID
-
The destination UUID.
- enabled
-
Whether the task is enabled or not.
- failureThreshold
-
A percentage representing the accepted failure threshold to determine if a
run
succeeded or not. - sourceID
-
The source UUID.
- taskID
-
The task UUID.
- updatedAt
-
Date of last update (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The payload for a task creation.
The payload for a task creation.
Value parameters
- destinationID
-
The destination UUID.
- enabled
-
Whether the task is enabled or not.
- failureThreshold
-
A percentage representing the accepted failure threshold to determine if a
run
succeeded or not. - sourceID
-
The source UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The response from the API after a task creation.
The response from the API after a task creation.
Value parameters
- createdAt
-
Date of creation (RFC3339 format).
- taskID
-
The task UUID.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
TaskCreateTrigger
TaskCreateTrigger
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait TaskCreateTriggerTraitclass OnDemandTriggerInputclass ScheduleTriggerInputclass SubscriptionTrigger
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
TaskCreateTrigger.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
TaskInput
TaskInput
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Supertypes
- Self type
-
TaskInputSerializer.type
Attributes
- Supertypes
- Known subtypes
-
class OnDemandDateUtilsInputclass ScheduleDateUtilsInput
TaskSearch
TaskSearch
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Used to sort the Task list endpoint.
Used to sort the Task list endpoint.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TaskSortKeys.type
Attributes
- Supertypes
-
class CustomSerializer[TaskSortKeys]trait Serializer[TaskSortKeys]class Objecttrait Matchableclass Any
The payload for a task update.
The payload for a task update.
Value parameters
- destinationID
-
The destination UUID.
- enabled
-
Whether the task is enabled or not.
- failureThreshold
-
A percentage representing the accepted failure threshold to determine if a
run
succeeded or not.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The response from the API after a task update.
The response from the API after a task update.
Value parameters
- taskID
-
The task UUID.
- updatedAt
-
Date of last update (RFC3339 format).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Trigger
Trigger
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Supertypes
- Self type
-
TriggerSerializer.type
Attributes
- Supertypes
- Known subtypes
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
The type of the task reflect how it can be used: - onDemand: a task that runs manually - schedule: a task that runs regularly, following a given cron expression - subscription: a task that runs after a subscription event is received from an integration (e.g. Webhook).
The type of the task reflect how it can be used: - onDemand: a task that runs manually - schedule: a task that runs regularly, following a given cron expression - subscription: a task that runs after a subscription event is received from an integration (e.g. Webhook).
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TriggerType.type
Attributes
- Supertypes
-
class CustomSerializer[TriggerType]trait Serializer[TriggerType]class Objecttrait Matchableclass Any
The trigger input for a task update.
The trigger input for a task update.
Value parameters
- cron
-
A cron expression that represent at which regularity the task should run.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The window parameter represents the holds the dates used to query the Observability data from the database in a given window.
The window parameter represents the holds the dates used to query the Observability data from the database in a given window.
Value parameters
- endDate
-
A date in format RFC3339 representing the newest possible data in query window.
- startDate
-
A date in format RFC3339 representing the oldest possible data in query window.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all