algoliasearch.ingestion.Task.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-scala_3 Show documentation
Scala client for Algolia Search API
There is a newer version: 2.9.2
Show newest version
/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks
  * to ingest your data. The Ingestion API powers the no-code [data
  * connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API
  * are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics
  * region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
  * Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia
  * application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required
  * access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID
  * and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must
  * be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
  * empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
  * errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
  * property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
  * `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
  * correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
  * be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
  * Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
  *
  * The version of the OpenAPI document: 1.0.0
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech Do not edit the class manually.
  */
package algoliasearch.ingestion

import algoliasearch.ingestion.ActionType._

/** Task
  *
  * @param taskID
  *   Universally unique identifier (UUID) of a task.
  * @param sourceID
  *   Universally uniqud identifier (UUID) of a source.
  * @param destinationID
  *   Universally unique identifier (UUID) of a destination resource.
  * @param cron
  *   Cron expression for the task's schedule.
  * @param lastRun
  *   The last time the scheduled task ran in RFC 3339 format.
  * @param nextRun
  *   The next scheduled run of the task in RFC 3339 format.
  * @param enabled
  *   Whether the task is enabled.
  * @param failureThreshold
  *   Maximum accepted percentage of failures for a task run to finish successfully.
  * @param cursor
  *   Date of the last cursor in RFC 3339 format.
  * @param createdAt
  *   Date of creation in RFC 3339 format.
  * @param updatedAt
  *   Date of last update in RFC 3339 format.
  */
case class Task(
    taskID: String,
    sourceID: String,
    destinationID: String,
    cron: Option[String] = scala.None,
    lastRun: Option[String] = scala.None,
    nextRun: Option[String] = scala.None,
    input: Option[TaskInput] = scala.None,
    enabled: Boolean,
    failureThreshold: Option[Int] = scala.None,
    action: ActionType,
    cursor: Option[String] = scala.None,
    createdAt: String,
    updatedAt: Option[String] = scala.None
)