commonMain.com.algolia.client.model.ingestion.Task.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-client-kotlin-jvm Show documentation

"Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for Kotlin lets you easily use the Algolia Search REST API from your JVM project, such as Android or backend implementations."

There is a newer version: 3.10.1

Show newest version

/** Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. */
package com.algolia.client.model.ingestion

import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
 * 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 enabled Whether the task is enabled.
 * @param createdAt Date of creation in RFC 3339 format.
 * @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 input
 * @param failureThreshold Maximum accepted percentage of failures for a task run to finish successfully.
 * @param action
 * @param cursor Date of the last cursor in RFC 3339 format.
 * @param updatedAt Date of last update in RFC 3339 format.
 */
@Serializable
public data class Task(

  /** Universally unique identifier (UUID) of a task. */
  @SerialName(value = "taskID") val taskID: String,

  /** Universally uniqud identifier (UUID) of a source. */
  @SerialName(value = "sourceID") val sourceID: String,

  /** Universally unique identifier (UUID) of a destination resource. */
  @SerialName(value = "destinationID") val destinationID: String,

  /** Whether the task is enabled. */
  @SerialName(value = "enabled") val enabled: Boolean,

  /** Date of creation in RFC 3339 format. */
  @SerialName(value = "createdAt") val createdAt: String,

  /** Cron expression for the task's schedule. */
  @SerialName(value = "cron") val cron: String? = null,

  /** The last time the scheduled task ran in RFC 3339 format. */
  @SerialName(value = "lastRun") val lastRun: String? = null,

  /** The next scheduled run of the task in RFC 3339 format. */
  @SerialName(value = "nextRun") val nextRun: String? = null,

  @SerialName(value = "input") val input: TaskInput? = null,

  /** Maximum accepted percentage of failures for a task run to finish successfully. */
  @SerialName(value = "failureThreshold") val failureThreshold: Int? = null,

  @SerialName(value = "action") val action: ActionType? = null,

  /** Date of the last cursor in RFC 3339 format. */
  @SerialName(value = "cursor") val cursor: String? = null,

  /** Date of last update in RFC 3339 format. */
  @SerialName(value = "updatedAt") val updatedAt: String? = null,
)