algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.ingestion

algoliasearch.ingestion

package algoliasearch.ingestion

Members list

Type members

Classlikes

sealed trait ActionType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Partial.type
object Replace.type
object Save.type
object ActionType

The action to perform on the Algolia index.

The action to perform on the Algolia index.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ActionType.type
class ActionTypeSerializer extends CustomSerializer[ActionType]

Attributes

Supertypes
class CustomSerializer[ActionType]
trait Serializer[ActionType]
class Object
trait Matchable
class Any
case class AuthAPIKey(key: String) extends AuthInputTrait

Authentication input used for token credentials.

Authentication input used for token credentials.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthAPIKeyPartial(key: Option[String]) extends AuthInputPartialTrait

Authentication input used for token credentials.

Authentication input used for token credentials.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthAlgolia(appID: String, apiKey: String) extends AuthInputTrait

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 Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthAlgoliaPartial(appID: Option[String], apiKey: Option[String]) extends AuthInputPartialTrait

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthBasic(username: String, password: String) extends AuthInputTrait

Authentication input for Basic login with username and password.

Authentication input for Basic login with username and password.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthBasicPartial(username: Option[String], password: Option[String]) extends AuthInputPartialTrait

Authentication input for Basic login with username and password.

Authentication input for Basic login with username and password.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthGoogleServiceAccount(clientEmail: String, privateKey: String) extends AuthInputTrait

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 Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthGoogleServiceAccountPartial(clientEmail: Option[String], privateKey: Option[String]) extends AuthInputPartialTrait

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait AuthInput

AuthInput

AuthInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AuthAPIKey
class AuthAlgolia
class AuthBasic
class AuthOAuth
Show all
object AuthInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
AuthInput.type
sealed trait AuthInputPartial

AuthInputPartial

AuthInputPartial

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
object AuthInputPartial

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object AuthInputPartialSerializer extends Serializer[AuthInputPartial]

Attributes

Supertypes
trait Serializer[AuthInputPartial]
class Object
trait Matchable
class Any
Self type
trait AuthInputPartialTrait extends AuthInputPartial

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AuthInputSerializer extends Serializer[AuthInput]

Attributes

Supertypes
trait Serializer[AuthInput]
class Object
trait Matchable
class Any
Self type
trait AuthInputTrait extends AuthInput

Attributes

Supertypes
trait AuthInput
class Object
trait Matchable
class Any
Known subtypes
class AuthAPIKey
class AuthAlgolia
class AuthBasic
class AuthOAuth
case class AuthOAuth(url: String, client_id: String, client_secret: String) extends AuthInputTrait

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 Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthOAuthPartial(url: Option[String], client_id: Option[String], client_secret: Option[String]) extends AuthInputPartialTrait

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Authentication(authenticationID: String, `type`: AuthenticationType, name: String, platform: Option[Platform], input: AuthInput, createdAt: String, updatedAt: Option[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthenticationCreate(`type`: AuthenticationType, name: String, platform: Option[Platform], input: AuthInput)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthenticationCreateResponse(authenticationID: String, name: String, createdAt: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthenticationSearch(authenticationIDs: Seq[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait AuthenticationSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AuthType.type
object CreatedAt.type
object Name.type
object Platform.type
object UpdatedAt.type
object AuthenticationSortKeys

Used to sort the Authentication list endpoint.

Used to sort the Authentication list endpoint.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class AuthenticationSortKeysSerializer extends CustomSerializer[AuthenticationSortKeys]

Attributes

Supertypes
class CustomSerializer[AuthenticationSortKeys]
trait Serializer[AuthenticationSortKeys]
class Object
trait Matchable
class Any
sealed trait AuthenticationType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Algolia.type
object ApiKey.type
object Basic.type
object GoogleServiceAccount.type
object Oauth.type
object AuthenticationType

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 Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class AuthenticationTypeSerializer extends CustomSerializer[AuthenticationType]

Attributes

Supertypes
class CustomSerializer[AuthenticationType]
trait Serializer[AuthenticationType]
class Object
trait Matchable
class Any
case class AuthenticationUpdate(`type`: Option[AuthenticationType], name: Option[String], platform: Option[Platform], input: Option[AuthInputPartial])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthenticationUpdateResponse(authenticationID: String, name: String, updatedAt: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BigCommerceChannel(id: Int, currencies: Option[Seq[String]])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BigCommerceMetafield(namespace: String, key: String)

BigCommerceMetafield

BigCommerceMetafield

Value parameters

key

The key identifier of the metafield.

namespace

The namespace of the metafield.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait BigQueryDataType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Ga360.type
object Ga4.type
object BigQueryDataType

BigQueryDataType enumeration

BigQueryDataType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class BigQueryDataTypeSerializer extends CustomSerializer[BigQueryDataType]

Attributes

Supertypes
class CustomSerializer[BigQueryDataType]
trait Serializer[BigQueryDataType]
class Object
trait Matchable
class Any
case class DeleteResponse(deletedAt: String)

DeleteResponse

DeleteResponse

Value parameters

deletedAt

Date of deletion (RFC3339 format).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Destination(destinationID: String, `type`: DestinationType, name: String, input: DestinationInput, createdAt: String, updatedAt: Option[String], authenticationID: Option[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationCreate(`type`: DestinationType, name: String, input: DestinationInput, authenticationID: Option[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationCreateResponse(destinationID: String, name: String, createdAt: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationIndexName(indexName: String, recordType: Option[RecordType], attributesToExclude: Option[Seq[String]]) extends DestinationInputTrait

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 remove bar from foo. To remove elements from an array, you can use the following: - "foo.[0].bar": will only remove bar from the first element of foo. - "foo.[*].bar": will remove bar from every elements of foo.

indexName

The index name to store data in.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationIndexPrefix(indexPrefix: String) extends DestinationInputTrait

DestinationIndexPrefix

DestinationIndexPrefix

Value parameters

indexPrefix

The prefix of the final index name.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait DestinationInput

DestinationInput

DestinationInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DestinationInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object DestinationInputSerializer extends Serializer[DestinationInput]

Attributes

Supertypes
trait Serializer[DestinationInput]
class Object
trait Matchable
class Any
Self type
trait DestinationInputTrait extends DestinationInput

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class DestinationSearch(destinationIDs: Seq[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait DestinationSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CreatedAt.type
object Name.type
object Type.type
object UpdatedAt.type
object DestinationSortKeys

Used to sort the Destination list endpoint.

Used to sort the Destination list endpoint.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class DestinationSortKeysSerializer extends CustomSerializer[DestinationSortKeys]

Attributes

Supertypes
class CustomSerializer[DestinationSortKeys]
trait Serializer[DestinationSortKeys]
class Object
trait Matchable
class Any
sealed trait DestinationType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Flow.type
object Insights.type
object Search.type
object DestinationType

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 Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class DestinationTypeSerializer extends CustomSerializer[DestinationType]

Attributes

Supertypes
class CustomSerializer[DestinationType]
trait Serializer[DestinationType]
class Object
trait Matchable
class Any
case class DestinationUpdate(`type`: Option[DestinationType], name: Option[String], input: Option[DestinationInput], authenticationID: Option[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationUpdateResponse(destinationID: String, name: String, updatedAt: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait DockerImageType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Airbyte.type
object Custom.type
object Singer.type
object DockerImageType

The type of the image.

The type of the image.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class DockerImageTypeSerializer extends CustomSerializer[DockerImageType]

Attributes

Supertypes
class CustomSerializer[DockerImageType]
trait Serializer[DockerImageType]
class Object
trait Matchable
class Any
sealed trait DockerRegistry

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Dockerhub.type
object Ghcr.type
object DockerRegistry

The registry where the image is stored.

The registry where the image is stored.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class DockerRegistrySerializer extends CustomSerializer[DockerRegistry]

Attributes

Supertypes
class CustomSerializer[DockerRegistry]
trait Serializer[DockerRegistry]
class Object
trait Matchable
class Any
case class DockerSourceDiscover(runID: String, createdAt: String)

DockerSourceDiscover

DockerSourceDiscover

Value parameters

createdAt

Date of creation (RFC3339 format).

runID

The run UUID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DockerSourceStreams(streams: Seq[Any])

DockerSourceStreams

DockerSourceStreams

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ErrorBase(message: Option[String], additionalProperties: Option[List[JField]])

Error.

Error.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class ErrorBaseSerializer extends Serializer[ErrorBase]

Attributes

Supertypes
trait Serializer[ErrorBase]
class Object
trait Matchable
class Any
case class Event(eventID: String, runID: String, parentID: Option[String], status: EventStatus, `type`: EventType, batchSize: Int, data: Option[Map[String, Any]], publishedAt: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait EventSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PublishedAt.type
object Status.type
object Type.type
object EventSortKeys

Used to sort the Event list endpoint.

Used to sort the Event list endpoint.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class EventSortKeysSerializer extends CustomSerializer[EventSortKeys]

Attributes

Supertypes
class CustomSerializer[EventSortKeys]
trait Serializer[EventSortKeys]
class Object
trait Matchable
class Any
sealed trait EventStatus

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Created.type
object Critical.type
object Failed.type
object Retried.type
object Started.type
object Succeeded.type
Show all
object EventStatus

EventStatus enumeration

EventStatus enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class EventStatusSerializer extends CustomSerializer[EventStatus]

Attributes

Supertypes
class CustomSerializer[EventStatus]
trait Serializer[EventStatus]
class Object
trait Matchable
class Any
sealed trait EventType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Fetch.type
object Log.type
object Record.type
object Transform.type
object EventType

EventType enumeration

EventType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
EventType.type
class EventTypeSerializer extends CustomSerializer[EventType]

Attributes

Supertypes
class CustomSerializer[EventType]
trait Serializer[EventType]
class Object
trait Matchable
class Any
object JsonSupport

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class ListAuthenticationsResponse(authentications: Seq[Authentication], pagination: Pagination)

ListAuthenticationsResponse

ListAuthenticationsResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListDestinationsResponse(destinations: Seq[Destination], pagination: Pagination)

ListDestinationsResponse

ListDestinationsResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListEventsResponse(events: Seq[Event], pagination: Pagination, window: Window)

ListEventsResponse

ListEventsResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListSourcesResponse(sources: Seq[Source], pagination: Pagination)

ListSourcesResponse

ListSourcesResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListTasksResponse(tasks: Seq[Task], pagination: Pagination)

A list of tasks with pagination details.

A list of tasks with pagination details.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait MappingTypeCSV

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Boolean.type
object Float.type
object Integer.type
object Json.type
object String.type
object MappingTypeCSV

MappingTypeCSV enumeration

MappingTypeCSV enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class MappingTypeCSVSerializer extends CustomSerializer[MappingTypeCSV]

Attributes

Supertypes
class CustomSerializer[MappingTypeCSV]
trait Serializer[MappingTypeCSV]
class Object
trait Matchable
class Any
sealed trait MethodType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GET.type
object POST.type
object MethodType

MethodType enumeration

MethodType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
MethodType.type
class MethodTypeSerializer extends CustomSerializer[MethodType]

Attributes

Supertypes
class CustomSerializer[MethodType]
trait Serializer[MethodType]
class Object
trait Matchable
class Any
case class OnDemandDateUtilsInput(startDate: String, endDate: String) extends TaskInputTrait

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 Serializable
trait Product
trait Equals
trait TaskInput
class Object
trait Matchable
class Any
Show all
case class OnDemandTrigger(`type`: OnDemandTriggerType, lastRun: Option[String]) extends TriggerTrait

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 Serializable
trait Product
trait Equals
trait TriggerTrait
trait Trigger
class Object
trait Matchable
class Any
Show all
case class OnDemandTriggerInput(`type`: OnDemandTriggerType) extends TaskCreateTriggerTrait

The trigger information of a task of type onDemand.

The trigger information of a task of type onDemand.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait OnDemandTriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object OnDemand.type
object OnDemandTriggerType

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 Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class OnDemandTriggerTypeSerializer extends CustomSerializer[OnDemandTriggerType]

Attributes

Supertypes
class CustomSerializer[OnDemandTriggerType]
trait Serializer[OnDemandTriggerType]
class Object
trait Matchable
class Any
sealed trait OrderKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Asc.type
object Desc.type
object OrderKeys

Used to order a sorted request.

Used to order a sorted request.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
OrderKeys.type
class OrderKeysSerializer extends CustomSerializer[OrderKeys]

Attributes

Supertypes
class CustomSerializer[OrderKeys]
trait Serializer[OrderKeys]
class Object
trait Matchable
class Any
case class Pagination(nbPages: Int, page: Int, nbItems: Int, itemsPerPage: Int)

Pagination

Pagination

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Platform extends PlatformWithNoneTrait

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Bigcommerce.type
object Commercetools.type
object Platform

Describe which platform the Authentication is used for.

Describe which platform the Authentication is used for.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Platform.type
sealed trait PlatformNone extends PlatformWithNoneTrait

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object None.type
object PlatformNone

Used to filter Authentication without platform property.

Used to filter Authentication without platform property.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class PlatformNoneSerializer extends CustomSerializer[PlatformNone]

Attributes

Supertypes
class CustomSerializer[PlatformNone]
trait Serializer[PlatformNone]
class Object
trait Matchable
class Any
class PlatformSerializer extends CustomSerializer[Platform]

Attributes

Supertypes
class CustomSerializer[Platform]
trait Serializer[Platform]
class Object
trait Matchable
class Any
sealed trait PlatformWithNone

PlatformWithNone

PlatformWithNone

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Platform
object Bigcommerce.type
object Commercetools.type
trait PlatformNone
object None.type
Show all
object PlatformWithNone

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object PlatformWithNoneSerializer extends Serializer[PlatformWithNone]

Attributes

Supertypes
trait Serializer[PlatformWithNone]
class Object
trait Matchable
class Any
Self type
trait PlatformWithNoneTrait extends PlatformWithNone

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Platform
object Bigcommerce.type
object Commercetools.type
trait PlatformNone
object None.type
sealed trait RecordType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Product.type
object Variant.type
object RecordType

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 Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RecordType.type
class RecordTypeSerializer extends CustomSerializer[RecordType]

Attributes

Supertypes
class CustomSerializer[RecordType]
trait Serializer[RecordType]
class Object
trait Matchable
class Any
case class Run(runID: String, appID: String, taskID: String, status: RunStatus, progress: Option[RunProgress], outcome: Option[RunOutcome], failureThreshold: Option[Int], reason: Option[String], reasonCode: Option[RunReasonCode], `type`: RunType, createdAt: String, startedAt: Option[String], finishedAt: Option[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RunListResponse(runs: Seq[Run], pagination: Pagination, window: Window)

RunListResponse

RunListResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait RunOutcome

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Failure.type
object Processing.type
object Success.type
object RunOutcome

RunOutcome enumeration

RunOutcome enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RunOutcome.type
class RunOutcomeSerializer extends CustomSerializer[RunOutcome]

Attributes

Supertypes
class CustomSerializer[RunOutcome]
trait Serializer[RunOutcome]
class Object
trait Matchable
class Any
case class RunProgress(expectedNbOfEvents: Option[Int], receivedNbOfEvents: Option[Int])

RunProgress

RunProgress

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait RunReasonCode

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Blocking.type
object Critical.type
object Discarded.type
object Internal.type
object NoEvents.type
object Ok.type
object TooManyErrors.type
Show all
object RunReasonCode

An identifier that pairs with the outcome reason.

An identifier that pairs with the outcome reason.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class RunReasonCodeSerializer extends CustomSerializer[RunReasonCode]

Attributes

Supertypes
class CustomSerializer[RunReasonCode]
trait Serializer[RunReasonCode]
class Object
trait Matchable
class Any
case class RunResponse(runID: String, createdAt: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait RunSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CreatedAt.type
object Status.type
object UpdatedAt.type
object RunSortKeys

Used to sort the Run list endpoint.

Used to sort the Run list endpoint.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class RunSortKeysSerializer extends CustomSerializer[RunSortKeys]

Attributes

Supertypes
class CustomSerializer[RunSortKeys]
trait Serializer[RunSortKeys]
class Object
trait Matchable
class Any
sealed trait RunStatus

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Created.type
object Finished.type
object Idled.type
object Skipped.type
object Started.type
object RunStatus

RunStatus enumeration

RunStatus enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RunStatus.type
class RunStatusSerializer extends CustomSerializer[RunStatus]

Attributes

Supertypes
class CustomSerializer[RunStatus]
trait Serializer[RunStatus]
class Object
trait Matchable
class Any
sealed trait RunType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Discover.type
object Reindex.type
object Update.type
object RunType

RunType enumeration

RunType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RunType.type
class RunTypeSerializer extends CustomSerializer[RunType]

Attributes

Supertypes
class CustomSerializer[RunType]
trait Serializer[RunType]
class Object
trait Matchable
class Any
case class ScheduleDateUtilsInput(timeframe: Int) extends TaskInputTrait

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 Serializable
trait Product
trait Equals
trait TaskInput
class Object
trait Matchable
class Any
Show all
case class ScheduleTrigger(`type`: ScheduleTriggerType, cron: String, lastRun: Option[String], nextRun: String) extends TriggerTrait

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 Serializable
trait Product
trait Equals
trait TriggerTrait
trait Trigger
class Object
trait Matchable
class Any
Show all
case class ScheduleTriggerInput(`type`: ScheduleTriggerType, cron: String) extends TaskCreateTriggerTrait

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait ScheduleTriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Schedule.type
object ScheduleTriggerType

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 Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class ScheduleTriggerTypeSerializer extends CustomSerializer[ScheduleTriggerType]

Attributes

Supertypes
class CustomSerializer[ScheduleTriggerType]
trait Serializer[ScheduleTriggerType]
class Object
trait Matchable
class Any
case class Source(sourceID: String, `type`: SourceType, name: String, input: SourceInput, authenticationID: Option[String], createdAt: String, updatedAt: Option[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceBigCommerce(storeHash: Option[String], channel: Option[BigCommerceChannel], customFields: Option[Seq[String]], productMetafields: Option[Seq[BigCommerceMetafield]], variantMetafields: Option[Seq[BigCommerceMetafield]]) extends SourceInputTrait

SourceBigCommerce

SourceBigCommerce

Value parameters

storeHash

The store hash identifying the store the shopper is signing in to.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceBigQuery(projectID: String, datasetID: String, dataType: Option[BigQueryDataType], table: Option[String], tablePrefix: Option[String], customSQLRequest: Option[String], uniqueIDColumn: Option[String]) extends SourceInputTrait, SourceUpdateInputTrait

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 Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceCSV(url: String, uniqueIDColumn: Option[String], mapping: Option[Map[String, MappingTypeCSV]], method: Option[MethodType], delimiter: Option[String]) extends SourceInputTrait, SourceUpdateInputTrait

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 Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceCommercetools(storeKeys: Option[Seq[String]], locales: Option[Seq[String]], url: String, projectKey: String, fallbackIsInStockValue: Option[Boolean]) extends SourceInputTrait

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 Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceCreate(`type`: SourceType, name: String, input: SourceInput, authenticationID: Option[String])

SourceCreate

SourceCreate

Value parameters

authenticationID

The authentication UUID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceCreateResponse(sourceID: String, name: String, createdAt: String)

SourceCreateResponse

SourceCreateResponse

Value parameters

createdAt

Date of creation (RFC3339 format).

sourceID

The source UUID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceDocker(imageType: DockerImageType, registry: DockerRegistry, image: String, version: Option[String], configuration: Any) extends SourceInputTrait

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 Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
sealed trait SourceInput

SourceInput

SourceInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SourceCSV
class SourceDocker
class SourceJSON
Show all
object SourceInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object SourceInputSerializer extends Serializer[SourceInput]

Attributes

Supertypes
trait Serializer[SourceInput]
class Object
trait Matchable
class Any
Self type
trait SourceInputTrait extends SourceInput

Attributes

Supertypes
trait SourceInput
class Object
trait Matchable
class Any
Known subtypes
class SourceCSV
class SourceDocker
class SourceJSON
Show all
case class SourceJSON(url: String, uniqueIDColumn: Option[String], method: Option[MethodType]) extends SourceInputTrait, SourceUpdateInputTrait

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 Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceSearch(sourceIDs: Seq[String])

SourceSearch

SourceSearch

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait SourceSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CreatedAt.type
object Name.type
object Type.type
object UpdatedAt.type
object SourceSortKeys

Used to sort the Source list endpoint.

Used to sort the Source list endpoint.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class SourceSortKeysSerializer extends CustomSerializer[SourceSortKeys]

Attributes

Supertypes
class CustomSerializer[SourceSortKeys]
trait Serializer[SourceSortKeys]
class Object
trait Matchable
class Any
sealed trait SourceType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Bigcommerce.type
object Bigquery.type
object Commercetools.type
object Csv.type
object Docker.type
object Json.type
Show all
object SourceType

SourceType enumeration

SourceType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
SourceType.type
class SourceTypeSerializer extends CustomSerializer[SourceType]

Attributes

Supertypes
class CustomSerializer[SourceType]
trait Serializer[SourceType]
class Object
trait Matchable
class Any
case class SourceUpdate(name: Option[String], input: Option[SourceUpdateInput], authenticationID: Option[String])

SourceUpdate

SourceUpdate

Value parameters

authenticationID

The authentication UUID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceUpdateCommercetools(storeKeys: Option[Seq[String]], locales: Option[Seq[String]]) extends SourceUpdateInputTrait

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceUpdateDocker(registry: Option[DockerRegistry], image: Option[String], version: Option[String], configuration: Any) extends SourceUpdateInputTrait

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait SourceUpdateInput

SourceUpdateInput

SourceUpdateInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SourceCSV
class SourceJSON
Show all
object SourceUpdateInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object SourceUpdateInputSerializer extends Serializer[SourceUpdateInput]

Attributes

Supertypes
trait Serializer[SourceUpdateInput]
class Object
trait Matchable
class Any
Self type
trait SourceUpdateInputTrait extends SourceUpdateInput

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SourceCSV
class SourceJSON
case class SourceUpdateResponse(sourceID: String, name: String, updatedAt: String)

SourceUpdateResponse

SourceUpdateResponse

Value parameters

sourceID

The source UUID.

updatedAt

Date of last update (RFC3339 format).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SubscriptionTrigger(`type`: SubscriptionTriggerType) extends TriggerTrait, TaskCreateTriggerTrait

The trigger input for a task of type 'subscription'.

The trigger input for a task of type 'subscription'.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TriggerTrait
trait Trigger
class Object
trait Matchable
class Any
Show all
sealed trait SubscriptionTriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Subscription.type
object SubscriptionTriggerType

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 Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class SubscriptionTriggerTypeSerializer extends CustomSerializer[SubscriptionTriggerType]

Attributes

Supertypes
class CustomSerializer[SubscriptionTriggerType]
trait Serializer[SubscriptionTriggerType]
class Object
trait Matchable
class Any
case class Task(taskID: String, sourceID: String, destinationID: String, trigger: Trigger, input: Option[TaskInput], enabled: Boolean, failureThreshold: Option[Int], action: ActionType, createdAt: String, updatedAt: Option[String])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TaskCreate(sourceID: String, destinationID: String, trigger: TaskCreateTrigger, action: ActionType, enabled: Option[Boolean], failureThreshold: Option[Int], input: Option[TaskInput])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TaskCreateResponse(taskID: String, createdAt: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait TaskCreateTrigger

TaskCreateTrigger

TaskCreateTrigger

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TaskCreateTrigger

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object TaskCreateTriggerSerializer extends Serializer[TaskCreateTrigger]

Attributes

Supertypes
trait Serializer[TaskCreateTrigger]
class Object
trait Matchable
class Any
Self type
trait TaskCreateTriggerTrait extends TaskCreateTrigger

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
sealed trait TaskInput

TaskInput

TaskInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TaskInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
TaskInput.type
object TaskInputSerializer extends Serializer[TaskInput]

Attributes

Supertypes
trait Serializer[TaskInput]
class Object
trait Matchable
class Any
Self type
trait TaskInputTrait extends TaskInput

Attributes

Supertypes
trait TaskInput
class Object
trait Matchable
class Any
Known subtypes
case class TaskSearch(taskIDs: Seq[String])

TaskSearch

TaskSearch

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait TaskSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Action.type
object CreatedAt.type
object Enabled.type
object TriggerType.type
object UpdatedAt.type
object TaskSortKeys

Used to sort the Task list endpoint.

Used to sort the Task list endpoint.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class TaskSortKeysSerializer extends CustomSerializer[TaskSortKeys]

Attributes

Supertypes
class CustomSerializer[TaskSortKeys]
trait Serializer[TaskSortKeys]
class Object
trait Matchable
class Any
case class TaskUpdate(destinationID: Option[String], trigger: Option[TriggerUpdateInput], input: Option[TaskInput], enabled: Option[Boolean], failureThreshold: Option[Int])

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TaskUpdateResponse(taskID: String, updatedAt: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Trigger

Trigger

Trigger

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait TriggerTrait
object Trigger

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Trigger.type
object TriggerSerializer extends Serializer[Trigger]

Attributes

Supertypes
trait Serializer[Trigger]
class Object
trait Matchable
class Any
Self type
trait TriggerTrait extends Trigger

Attributes

Supertypes
trait Trigger
class Object
trait Matchable
class Any
Known subtypes
sealed trait TriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object OnDemand.type
object Schedule.type
object Subscription.type
object TriggerType

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 Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class TriggerTypeSerializer extends CustomSerializer[TriggerType]

Attributes

Supertypes
class CustomSerializer[TriggerType]
trait Serializer[TriggerType]
class Object
trait Matchable
class Any
case class TriggerUpdateInput(cron: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Window(startDate: String, endDate: String)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with