|
| 1 | +/** Ingestion API The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks |
| 2 | + * to ingest your data. The Ingestion API powers the no-code [data |
| 3 | + * connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API |
| 4 | + * are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics |
| 5 | + * region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ## |
| 6 | + * Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia |
| 7 | + * application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required |
| 8 | + * access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID |
| 9 | + * and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must |
| 10 | + * be JSON objects. ## Response status and errors Response bodies are JSON objects. Successful responses return a `2xx` |
| 11 | + * status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a |
| 12 | + * `message` property with more information. ## Version The current version of the Ingestion API is version 1, as |
| 13 | + * indicated by the `/1/` in each endpoint's URL. |
| 14 | + * |
| 15 | + * The version of the OpenAPI document: 1.0.0 |
| 16 | + * |
| 17 | + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). |
| 18 | + * https://openapi-generator.tech Do not edit the class manually. |
| 19 | + */ |
| 20 | +package algoliasearch.ingestion |
| 21 | + |
| 22 | +import algoliasearch.ingestion.ActionType._ |
| 23 | + |
| 24 | +/** API request body for updating a task. |
| 25 | + * |
| 26 | + * @param destinationID |
| 27 | + * Universally unique identifier (UUID) of a destination resource. |
| 28 | + * @param cron |
| 29 | + * Cron expression for the task's schedule. |
| 30 | + * @param enabled |
| 31 | + * Whether the task is enabled. |
| 32 | + * @param failureThreshold |
| 33 | + * Maximum accepted percentage of failures for a task run to finish successfully. |
| 34 | + * @param cursor |
| 35 | + * Date of the last cursor in RFC 3339 format. |
| 36 | + */ |
| 37 | +case class TaskReplace( |
| 38 | + destinationID: String, |
| 39 | + action: ActionType, |
| 40 | + subscriptionAction: Option[ActionType] = scala.None, |
| 41 | + cron: Option[String] = scala.None, |
| 42 | + enabled: Option[Boolean] = scala.None, |
| 43 | + failureThreshold: Option[Int] = scala.None, |
| 44 | + input: Option[TaskInput] = scala.None, |
| 45 | + cursor: Option[String] = scala.None, |
| 46 | + notifications: Option[Notifications] = scala.None, |
| 47 | + policies: Option[Policies] = scala.None |
| 48 | +) |
0 commit comments