Docs API schemas

neoserver 0.1.2

MosaicHarvestJob

MosaicHarvestJob schema for the neoserver management API.

← All schemas

object
cancel_requested boolean
completed_at string · date-time
created_at string · date-time required
created_by string
error_message string
failed_granules integer · int64
generation integer · int64
id string required
processed_granules integer · int64 required
request object required
directory string
granules array of MosaicHarvestGranule ↗
mode string
Allowed values
["append","synchronize"]
pattern string
service_id string required
started_at string · date-time
status string required
Allowed values
["queued","running","cancelling","cancelled","succeeded","failed"]
succeeded_granules integer · int64
total_granules integer · int64 required
updated_at string · date-time required
workspace_id string required
OpenAPI schema definition
{
  "properties": {
    "cancel_requested": {
      "type": "boolean"
    },
    "completed_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "error_message": {
      "type": "string"
    },
    "failed_granules": {
      "format": "int64",
      "type": "integer"
    },
    "generation": {
      "format": "int64",
      "type": "integer"
    },
    "id": {
      "type": "string"
    },
    "processed_granules": {
      "format": "int64",
      "type": "integer"
    },
    "request": {
      "properties": {
        "directory": {
          "type": "string"
        },
        "granules": {
          "items": {
            "$ref": "#/components/schemas/MosaicHarvestGranule"
          },
          "type": "array"
        },
        "mode": {
          "enum": [
            "append",
            "synchronize"
          ],
          "type": "string"
        },
        "pattern": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "service_id": {
      "type": "string"
    },
    "started_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "queued",
        "running",
        "cancelling",
        "cancelled",
        "succeeded",
        "failed"
      ],
      "type": "string"
    },
    "succeeded_granules": {
      "format": "int64",
      "type": "integer"
    },
    "total_granules": {
      "format": "int64",
      "type": "integer"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "workspace_id": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "workspace_id",
    "service_id",
    "request",
    "status",
    "total_granules",
    "processed_granules",
    "created_at",
    "updated_at"
  ],
  "type": "object"
}

Search documentation

Type to search guides and reference pages.