All Products
Search
Document Center

ScheduledTask

Last Updated: Sep 09, 2021

Description

The information about a scheduled reindexing task of an OpenSearch application.

Example

{
    "id": "cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec",
    "progress": 0,
    "status": 3,
    "lastRanTimestamp": null,
    "type": "wipe",
    "running": false,
    "paused": false,
    "finished": false,
    "idle": true,
    "created": 1593747144,
    "updated": 1593747144,
    "cron": "0 0 * * 1,2,3,4,5,6,7",
    "enabled": true,
  "appId": null,
  "appGroupId": "100303899",
  "ownerId": "84",
    "lastScheduledTimestamp": null,
    "forkedAppId": "",
  "appGroup": {
    "id": "100303899"
  },
  "owner": {
    "id": "84"
  },
    "filter": {
        "field": "title",
        "days": 30,
        "unit": "s"
    }
}

Structure

Field

Type

Description

id

String

The ID of the scheduled reindexing task.

progress

Integer

The progress of the scheduled reindexing task.

status

Integer

The status of the scheduled reindexing task. Valid values:- 0: The task is running.- 1: The task is paused.- 2: The task is complete.- 3: The task is idle.

lastRanTimestamp

Integer/null

The timestamp when the scheduled reindexing task was last run.

type

String

The type of the scheduled task. Valid values:- wipe: a data clearance task- fork: an automatic reindexing task- check-status: a task that checks the status of the application- index: a manual reindexing task- app

running

Boolean

Indicates whether the task is running.

paused

Boolean

Indicates whether the task is paused.

finished

Boolean

Indicates whether the task is complete.

idle

Boolean

Indicates whether the task is idle.

cron

String

The scheduling properties. For more information, see cron field in ScheduledTask.

enabled

Boolean

Indicates whether the scheduled task is enabled.

appId

String

The ID of the version.

appGroupId

String

The ID of the application.

ownerId

String

The ID of the owner.

lastScheduledTimestamp

Integer/null

The timestamp when the task was last scheduled.

forkedAppId

String

The ID of the source version based on which reindexing is performed.

appGroup.id

String

The ID of the application.

owner.id

String

The ID of the owner.

filter

Object

The conditions that are used to clear data.

filter.days

Integer

The expiration time of fields. Valid values: [7,180]. Unit: day.

filter.unit

String

The unit of the expiration time of the field. Valid values:- s: seconds- ms: milliseconds

filter.field

String

The field that the task clears based on the expiration settings.