This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.4!spring-doc.cn

This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.4!spring-doc.cn

The quartz endpoint provides information about jobs and triggers that are managed by the Quartz Scheduler.spring-doc.cn

Retrieving Registered Groups

Jobs and triggers are managed in groups. To retrieve the list of registered job and trigger groups, make a GET request to /actuator/quartz, as shown in the following curl-based example:spring-doc.cn

$ curl 'http://localhost:8080/actuator/quartz' -i -X GET

The resulting response is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 120

{
  "jobs" : {
    "groups" : [ "samples", "tests" ]
  },
  "triggers" : {
    "groups" : [ "samples", "DEFAULT" ]
  }
}

Response Structure

The response contains the groups names for registered jobs and triggers. The following table describes the structure of the response:spring-doc.cn

Path Type Description

jobs.groupsspring-doc.cn

Arrayspring-doc.cn

An array of job group names.spring-doc.cn

triggers.groupsspring-doc.cn

Arrayspring-doc.cn

An array of trigger group names.spring-doc.cn
Path Type Description

jobs.groupsspring-doc.cn

Arrayspring-doc.cn

An array of job group names.spring-doc.cn

triggers.groupsspring-doc.cn

Arrayspring-doc.cn

An array of trigger group names.spring-doc.cn

Retrieving Registered Job Names

To retrieve the list of registered job names, make a GET request to /actuator/quartz/jobs, as shown in the following curl-based example:spring-doc.cn

$ curl 'http://localhost:8080/actuator/quartz/jobs' -i -X GET

The resulting response is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 137

{
  "groups" : {
    "samples" : {
      "jobs" : [ "jobOne", "jobTwo" ]
    },
    "tests" : {
      "jobs" : [ "jobThree" ]
    }
  }
}

Response Structure

The response contains the registered job names for each group. The following table describes the structure of the response:spring-doc.cn

Path Type Description

groupsspring-doc.cn

Objectspring-doc.cn

Job groups keyed by name.spring-doc.cn

groups.*.jobsspring-doc.cn

Arrayspring-doc.cn

An array of job names.spring-doc.cn
Path Type Description

groupsspring-doc.cn

Objectspring-doc.cn

Job groups keyed by name.spring-doc.cn

groups.*.jobsspring-doc.cn

Arrayspring-doc.cn

An array of job names.spring-doc.cn

Retrieving Registered Trigger Names

To retrieve the list of registered trigger names, make a GET request to /actuator/quartz/triggers, as shown in the following curl-based example:spring-doc.cn

$ curl 'http://localhost:8080/actuator/quartz/triggers' -i -X GET

The resulting response is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 229

{
  "groups" : {
    "samples" : {
      "paused" : false,
      "triggers" : [ "3am-weekdays", "every-day", "once-a-week" ]
    },
    "DEFAULT" : {
      "paused" : false,
      "triggers" : [ "every-hour-tue-thu" ]
    }
  }
}

Response Structure

The response contains the registered trigger names for each group. The following table describes the structure of the response:spring-doc.cn

Path Type Description

groupsspring-doc.cn

Objectspring-doc.cn

Trigger groups keyed by name.spring-doc.cn

groups.*.pausedspring-doc.cn

Booleanspring-doc.cn

Whether this trigger group is paused.spring-doc.cn

groups.*.triggersspring-doc.cn

Arrayspring-doc.cn

An array of trigger names.spring-doc.cn
Path Type Description

groupsspring-doc.cn

Objectspring-doc.cn

Trigger groups keyed by name.spring-doc.cn

groups.*.pausedspring-doc.cn

Booleanspring-doc.cn

Whether this trigger group is paused.spring-doc.cn

groups.*.triggersspring-doc.cn

Arrayspring-doc.cn

An array of trigger names.spring-doc.cn

Retrieving Overview of a Job Group

To retrieve an overview of the jobs in a particular group, make a GET request to /actuator/quartz/jobs/{groupName}, as shown in the following curl-based example:spring-doc.cn

$ curl 'http://localhost:8080/actuator/quartz/jobs/samples' -i -X GET

The preceding example retrieves the summary for jobs in the samples group. The resulting response is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 201

{
  "group" : "samples",
  "jobs" : {
    "jobOne" : {
      "className" : "org.springframework.scheduling.quartz.DelegatingJob"
    },
    "jobTwo" : {
      "className" : "org.quartz.Job"
    }
  }
}

Response Structure

The response contains an overview of jobs in a particular group. The following table describes the structure of the response:spring-doc.cn

Path Type Description

groupspring-doc.cn

Stringspring-doc.cn

Name of the group.spring-doc.cn

jobsspring-doc.cn

Objectspring-doc.cn

Job details keyed by name.spring-doc.cn

jobs.*.classNamespring-doc.cn

Stringspring-doc.cn

Fully qualified name of the job implementation.spring-doc.cn
Path Type Description

groupspring-doc.cn

Stringspring-doc.cn

Name of the group.spring-doc.cn

jobsspring-doc.cn

Objectspring-doc.cn

Job details keyed by name.spring-doc.cn

jobs.*.classNamespring-doc.cn

Stringspring-doc.cn

Fully qualified name of the job implementation.spring-doc.cn

Retrieving Overview of a Trigger Group

To retrieve an overview of the triggers in a particular group, make a GET request to /actuator/quartz/triggers/{groupName}, as shown in the following curl-based example:spring-doc.cn

$ curl 'http://localhost:8080/actuator/quartz/triggers/tests' -i -X GET

The preceding example retrieves the summary for triggers in the tests group. The resulting response is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 1268

{
  "group" : "tests",
  "paused" : false,
  "triggers" : {
    "cron" : {
      "3am-week" : {
        "previousFireTime" : "2020-12-04T03:00:00.000+00:00",
        "nextFireTime" : "2020-12-07T03:00:00.000+00:00",
        "priority" : 3,
        "expression" : "0 0 3 ? * 1,2,3,4,5",
        "timeZone" : "Europe/Paris"
      }
    },
    "simple" : {
      "every-day" : {
        "nextFireTime" : "2020-12-04T12:00:00.000+00:00",
        "priority" : 7,
        "interval" : 86400000
      }
    },
    "dailyTimeInterval" : {
      "tue-thu" : {
        "priority" : 5,
        "interval" : 3600000,
        "daysOfWeek" : [ 3, 5 ],
        "startTimeOfDay" : "09:00:00",
        "endTimeOfDay" : "18:00:00"
      }
    },
    "calendarInterval" : {
      "once-a-week" : {
        "previousFireTime" : "2020-12-02T14:00:00.000+00:00",
        "nextFireTime" : "2020-12-08T14:00:00.000+00:00",
        "priority" : 5,
        "interval" : 604800000,
        "timeZone" : "Etc/UTC"
      }
    },
    "custom" : {
      "once-a-year-custom" : {
        "previousFireTime" : "2020-07-14T16:00:00.000+00:00",
        "nextFireTime" : "2021-07-14T16:00:00.000+00:00",
        "priority" : 10,
        "trigger" : "com.example.CustomTrigger@fdsfsd"
      }
    }
  }
}

Response Structure

The response contains an overview of triggers in a particular group. Trigger implementation specific details are available. The following table describes the structure of the response:spring-doc.cn

Path Type Description

groupspring-doc.cn

Stringspring-doc.cn

Name of the group.spring-doc.cn

pausedspring-doc.cn

Booleanspring-doc.cn

Whether the group is paused.spring-doc.cn

triggers.cronspring-doc.cn

Objectspring-doc.cn

Cron triggers keyed by name, if any.spring-doc.cn

triggers.simplespring-doc.cn

Objectspring-doc.cn

Simple triggers keyed by name, if any.spring-doc.cn

triggers.dailyTimeIntervalspring-doc.cn

Objectspring-doc.cn

Daily time interval triggers keyed by name, if any.spring-doc.cn

triggers.calendarIntervalspring-doc.cn

Objectspring-doc.cn

Calendar interval triggers keyed by name, if any.spring-doc.cn

triggers.customspring-doc.cn

Objectspring-doc.cn

Any other triggers keyed by name, if any.spring-doc.cn

triggers.cron.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.cron.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.cron.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.cron.*.expressionspring-doc.cn

Stringspring-doc.cn

Cron expression to use.spring-doc.cn

triggers.cron.*.timeZonespring-doc.cn

Stringspring-doc.cn

Time zone for which the expression will be resolved, if any.spring-doc.cn

triggers.simple.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.simple.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.simple.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.simple.*.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, between two executions.spring-doc.cn

triggers.dailyTimeInterval.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.dailyTimeInterval.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.dailyTimeInterval.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.dailyTimeInterval.*.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, added to the fire time in order to calculate the time of the next trigger repeat.spring-doc.cn

triggers.dailyTimeInterval.*.daysOfWeekspring-doc.cn

Arrayspring-doc.cn

An array of days of the week upon which to fire.spring-doc.cn

triggers.dailyTimeInterval.*.startTimeOfDayspring-doc.cn

Stringspring-doc.cn

Time of day to start firing at the given interval, if any.spring-doc.cn

triggers.dailyTimeInterval.*.endTimeOfDayspring-doc.cn

Stringspring-doc.cn

Time of day to complete firing at the given interval, if any.spring-doc.cn

triggers.calendarInterval.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.calendarInterval.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.calendarInterval.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.calendarInterval.*.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, added to the fire time in order to calculate the time of the next trigger repeat.spring-doc.cn

triggers.calendarInterval.*.timeZonespring-doc.cn

Stringspring-doc.cn

Time zone within which time calculations will be performed, if any.spring-doc.cn

triggers.custom.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.custom.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.custom.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.custom.*.triggerspring-doc.cn

Stringspring-doc.cn

A toString representation of the custom trigger instance.spring-doc.cn
Path Type Description

groupspring-doc.cn

Stringspring-doc.cn

Name of the group.spring-doc.cn

pausedspring-doc.cn

Booleanspring-doc.cn

Whether the group is paused.spring-doc.cn

triggers.cronspring-doc.cn

Objectspring-doc.cn

Cron triggers keyed by name, if any.spring-doc.cn

triggers.simplespring-doc.cn

Objectspring-doc.cn

Simple triggers keyed by name, if any.spring-doc.cn

triggers.dailyTimeIntervalspring-doc.cn

Objectspring-doc.cn

Daily time interval triggers keyed by name, if any.spring-doc.cn

triggers.calendarIntervalspring-doc.cn

Objectspring-doc.cn

Calendar interval triggers keyed by name, if any.spring-doc.cn

triggers.customspring-doc.cn

Objectspring-doc.cn

Any other triggers keyed by name, if any.spring-doc.cn

triggers.cron.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.cron.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.cron.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.cron.*.expressionspring-doc.cn

Stringspring-doc.cn

Cron expression to use.spring-doc.cn

triggers.cron.*.timeZonespring-doc.cn

Stringspring-doc.cn

Time zone for which the expression will be resolved, if any.spring-doc.cn

triggers.simple.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.simple.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.simple.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.simple.*.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, between two executions.spring-doc.cn

triggers.dailyTimeInterval.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.dailyTimeInterval.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.dailyTimeInterval.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.dailyTimeInterval.*.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, added to the fire time in order to calculate the time of the next trigger repeat.spring-doc.cn

triggers.dailyTimeInterval.*.daysOfWeekspring-doc.cn

Arrayspring-doc.cn

An array of days of the week upon which to fire.spring-doc.cn

triggers.dailyTimeInterval.*.startTimeOfDayspring-doc.cn

Stringspring-doc.cn

Time of day to start firing at the given interval, if any.spring-doc.cn

triggers.dailyTimeInterval.*.endTimeOfDayspring-doc.cn

Stringspring-doc.cn

Time of day to complete firing at the given interval, if any.spring-doc.cn

triggers.calendarInterval.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.calendarInterval.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.calendarInterval.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.calendarInterval.*.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, added to the fire time in order to calculate the time of the next trigger repeat.spring-doc.cn

triggers.calendarInterval.*.timeZonespring-doc.cn

Stringspring-doc.cn

Time zone within which time calculations will be performed, if any.spring-doc.cn

triggers.custom.*.previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.custom.*.nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.custom.*.priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

triggers.custom.*.triggerspring-doc.cn

Stringspring-doc.cn

A toString representation of the custom trigger instance.spring-doc.cn

Retrieving Details of a Job

To retrieve the details about a particular job, make a GET request to /actuator/quartz/jobs/{groupName}/{jobName}, as shown in the following curl-based example:spring-doc.cn

$ curl 'http://localhost:8080/actuator/quartz/jobs/samples/jobOne' -i -X GET

The preceding example retrieves the details of the job identified by the samples group and jobOne name. The resulting response is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 609

{
  "group" : "samples",
  "name" : "jobOne",
  "description" : "A sample job",
  "className" : "org.springframework.scheduling.quartz.DelegatingJob",
  "durable" : false,
  "requestRecovery" : false,
  "data" : {
    "password" : "secret",
    "user" : "admin"
  },
  "triggers" : [ {
    "group" : "samples",
    "name" : "every-day",
    "previousFireTime" : "2020-12-04T03:00:00.000+00:00",
    "nextFireTime" : "2020-12-04T12:00:00.000+00:00",
    "priority" : 7
  }, {
    "group" : "samples",
    "name" : "3am-weekdays",
    "nextFireTime" : "2020-12-07T03:00:00.000+00:00",
    "priority" : 3
  } ]
}

If a key in the data map is identified as sensitive, its value is sanitized.spring-doc.cn

Response Structure

The response contains the full details of a job including a summary of the triggers associated with it, if any. The triggers are sorted by next fire time and priority. The following table describes the structure of the response:spring-doc.cn

Path Type Description

groupspring-doc.cn

Stringspring-doc.cn

Name of the group.spring-doc.cn

namespring-doc.cn

Stringspring-doc.cn

Name of the job.spring-doc.cn

descriptionspring-doc.cn

Stringspring-doc.cn

Description of the job, if any.spring-doc.cn

classNamespring-doc.cn

Stringspring-doc.cn

Fully qualified name of the job implementation.spring-doc.cn

durablespring-doc.cn

Booleanspring-doc.cn

Whether the job should remain stored after it is orphaned.spring-doc.cn

requestRecoveryspring-doc.cn

Booleanspring-doc.cn

Whether the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered.spring-doc.cn

data.*spring-doc.cn

Stringspring-doc.cn

Job data map as key/value pairs, if any.spring-doc.cn

triggersspring-doc.cn

Arrayspring-doc.cn

An array of triggers associated to the job, if any.spring-doc.cn

triggers.[].groupspring-doc.cn

Stringspring-doc.cn

Name of the trigger group.spring-doc.cn

triggers.[].namespring-doc.cn

Stringspring-doc.cn

Name of the trigger.spring-doc.cn

triggers.[].previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.[].nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.[].priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn
Path Type Description

groupspring-doc.cn

Stringspring-doc.cn

Name of the group.spring-doc.cn

namespring-doc.cn

Stringspring-doc.cn

Name of the job.spring-doc.cn

descriptionspring-doc.cn

Stringspring-doc.cn

Description of the job, if any.spring-doc.cn

classNamespring-doc.cn

Stringspring-doc.cn

Fully qualified name of the job implementation.spring-doc.cn

durablespring-doc.cn

Booleanspring-doc.cn

Whether the job should remain stored after it is orphaned.spring-doc.cn

requestRecoveryspring-doc.cn

Booleanspring-doc.cn

Whether the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered.spring-doc.cn

data.*spring-doc.cn

Stringspring-doc.cn

Job data map as key/value pairs, if any.spring-doc.cn

triggersspring-doc.cn

Arrayspring-doc.cn

An array of triggers associated to the job, if any.spring-doc.cn

triggers.[].groupspring-doc.cn

Stringspring-doc.cn

Name of the trigger group.spring-doc.cn

triggers.[].namespring-doc.cn

Stringspring-doc.cn

Name of the trigger.spring-doc.cn

triggers.[].previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

triggers.[].nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

triggers.[].priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

Retrieving Details of a Trigger

To retrieve the details about a particular trigger, make a GET request to /actuator/quartz/triggers/{groupName}/{triggerName}, as shown in the following curl-based example:spring-doc.cn

$ curl 'http://localhost:8080/actuator/quartz/triggers/samples/example' -i -X GET

The preceding example retrieves the details of trigger identified by the samples group and example name.spring-doc.cn

Common Response Structure

The response has a common structure and an additional object that is specific to the trigger’s type. There are five supported types:spring-doc.cn

The following table describes the structure of the common elements of the response:spring-doc.cn

Path Type Description

groupspring-doc.cn

Stringspring-doc.cn

Name of the group.spring-doc.cn

namespring-doc.cn

Stringspring-doc.cn

Name of the trigger.spring-doc.cn

descriptionspring-doc.cn

Stringspring-doc.cn

Description of the trigger, if any.spring-doc.cn

statespring-doc.cn

Stringspring-doc.cn

State of the trigger (NONE, NORMAL, PAUSED, COMPLETE, ERROR, BLOCKED).spring-doc.cn

typespring-doc.cn

Stringspring-doc.cn

Type of the trigger (calendarInterval, cron, custom, dailyTimeInterval, simple). Determines the key of the object containing type-specific details.spring-doc.cn

calendarNamespring-doc.cn

Stringspring-doc.cn

Name of the Calendar associated with this Trigger, if any.spring-doc.cn

startTimespring-doc.cn

Stringspring-doc.cn

Time at which the Trigger should take effect, if any.spring-doc.cn

endTimespring-doc.cn

Stringspring-doc.cn

Time at which the Trigger should quit repeating, regardless of any remaining repeats, if any.spring-doc.cn

previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

finalFireTimespring-doc.cn

Stringspring-doc.cn

Last time at which the Trigger will fire, if any.spring-doc.cn

dataspring-doc.cn

Objectspring-doc.cn

Job data map keyed by name, if any.spring-doc.cn

calendarIntervalspring-doc.cn

Objectspring-doc.cn

Calendar time interval trigger details, if any. Present when type is calendarInterval.spring-doc.cn

customspring-doc.cn

Objectspring-doc.cn

Custom trigger details, if any. Present when type is custom.spring-doc.cn

cronspring-doc.cn

Objectspring-doc.cn

Cron trigger details, if any. Present when type is cron.spring-doc.cn

dailyTimeIntervalspring-doc.cn

Objectspring-doc.cn

Daily time interval trigger details, if any. Present when type is dailyTimeInterval.spring-doc.cn

simplespring-doc.cn

Objectspring-doc.cn

Simple trigger details, if any. Present when type is simple.spring-doc.cn

Cron Trigger Response Structure

A cron trigger defines the cron expression that is used to determine when it has to fire. The resulting response for such a trigger implementation is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 490

{
  "group" : "samples",
  "name" : "example",
  "description" : "Example trigger",
  "state" : "NORMAL",
  "type" : "cron",
  "calendarName" : "bankHolidays",
  "startTime" : "2020-11-30T17:00:00.000+00:00",
  "endTime" : "2020-12-30T03:00:00.000+00:00",
  "previousFireTime" : "2020-12-04T03:00:00.000+00:00",
  "nextFireTime" : "2020-12-07T03:00:00.000+00:00",
  "priority" : 3,
  "data" : { },
  "cron" : {
    "expression" : "0 0 3 ? * 1,2,3,4,5",
    "timeZone" : "Europe/Paris"
  }
}

Much of the response is common to all trigger types. The structure of the common elements of the response was described previously. The following table describes the structure of the parts of the response that are specific to cron triggers:spring-doc.cn

Path Type Description

cronspring-doc.cn

Objectspring-doc.cn

Cron trigger specific details.spring-doc.cn

cron.expressionspring-doc.cn

Stringspring-doc.cn

Cron expression to use.spring-doc.cn

cron.timeZonespring-doc.cn

Stringspring-doc.cn

Time zone for which the expression will be resolved, if any.spring-doc.cn

Simple Trigger Response Structure

A simple trigger is used to fire a Job at a given moment in time, and optionally repeated at a specified interval. The resulting response for such a trigger implementation is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 549

{
  "group" : "samples",
  "name" : "example",
  "description" : "Example trigger",
  "state" : "NORMAL",
  "type" : "simple",
  "calendarName" : "bankHolidays",
  "startTime" : "2020-11-30T17:00:00.000+00:00",
  "endTime" : "2020-12-30T03:00:00.000+00:00",
  "previousFireTime" : "2020-12-04T03:00:00.000+00:00",
  "nextFireTime" : "2020-12-07T03:00:00.000+00:00",
  "priority" : 7,
  "finalFireTime" : "2020-12-29T17:00:00.000+00:00",
  "data" : { },
  "simple" : {
    "interval" : 86400000,
    "repeatCount" : -1,
    "timesTriggered" : 0
  }
}

Much of the response is common to all trigger types. The structure of the common elements of the response was described previously. The following table describes the structure of the parts of the response that are specific to simple triggers:spring-doc.cn

Path Type Description

simplespring-doc.cn

Objectspring-doc.cn

Simple trigger specific details.spring-doc.cn

simple.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, between two executions.spring-doc.cn

simple.repeatCountspring-doc.cn

Numberspring-doc.cn

Number of times the trigger should repeat, or -1 to repeat indefinitely.spring-doc.cn

simple.timesTriggeredspring-doc.cn

Numberspring-doc.cn

Number of times the trigger has already fired.spring-doc.cn

Daily Time Interval Trigger Response Structure

A daily time interval trigger is used to fire a Job based upon daily repeating time intervals. The resulting response for such a trigger implementation is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 667

{
  "group" : "samples",
  "name" : "example",
  "description" : "Example trigger",
  "state" : "PAUSED",
  "type" : "dailyTimeInterval",
  "calendarName" : "bankHolidays",
  "startTime" : "2020-11-30T17:00:00.000+00:00",
  "endTime" : "2020-12-30T03:00:00.000+00:00",
  "previousFireTime" : "2020-12-04T03:00:00.000+00:00",
  "nextFireTime" : "2020-12-07T03:00:00.000+00:00",
  "priority" : 5,
  "finalFireTime" : "2020-12-30T18:00:00.000+00:00",
  "data" : { },
  "dailyTimeInterval" : {
    "interval" : 3600000,
    "daysOfWeek" : [ 3, 5 ],
    "startTimeOfDay" : "09:00:00",
    "endTimeOfDay" : "18:00:00",
    "repeatCount" : -1,
    "timesTriggered" : 0
  }
}

Much of the response is common to all trigger types. The structure of the common elements of the response was described previously. The following table describes the structure of the parts of the response that are specific to daily time interval triggers:spring-doc.cn

Path Type Description

dailyTimeIntervalspring-doc.cn

Objectspring-doc.cn

Daily time interval trigger specific details.spring-doc.cn

dailyTimeInterval.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, added to the fire time in order to calculate the time of the next trigger repeat.spring-doc.cn

dailyTimeInterval.daysOfWeekspring-doc.cn

Arrayspring-doc.cn

An array of days of the week upon which to fire.spring-doc.cn

dailyTimeInterval.startTimeOfDayspring-doc.cn

Stringspring-doc.cn

Time of day to start firing at the given interval, if any.spring-doc.cn

dailyTimeInterval.endTimeOfDayspring-doc.cn

Stringspring-doc.cn

Time of day to complete firing at the given interval, if any.spring-doc.cn

dailyTimeInterval.repeatCountspring-doc.cn

Numberspring-doc.cn

Number of times the trigger should repeat, or -1 to repeat indefinitely.spring-doc.cn

dailyTimeInterval.timesTriggeredspring-doc.cn

Numberspring-doc.cn

Number of times the trigger has already fired.spring-doc.cn

Calendar Interval Trigger Response Structure

A calendar interval trigger is used to fire a Job based upon repeating calendar time intervals. The resulting response for such a trigger implementation is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 669

{
  "group" : "samples",
  "name" : "example",
  "description" : "Example trigger",
  "state" : "NORMAL",
  "type" : "calendarInterval",
  "calendarName" : "bankHolidays",
  "startTime" : "2020-11-30T17:00:00.000+00:00",
  "endTime" : "2020-12-30T03:00:00.000+00:00",
  "previousFireTime" : "2020-12-04T03:00:00.000+00:00",
  "nextFireTime" : "2020-12-07T03:00:00.000+00:00",
  "priority" : 5,
  "finalFireTime" : "2020-12-28T17:00:00.000+00:00",
  "data" : { },
  "calendarInterval" : {
    "interval" : 604800000,
    "timeZone" : "Etc/UTC",
    "timesTriggered" : 0,
    "preserveHourOfDayAcrossDaylightSavings" : false,
    "skipDayIfHourDoesNotExist" : false
  }
}

Much of the response is common to all trigger types. The structure of the common elements of the response was described previously. The following table describes the structure of the parts of the response that are specific to calendar interval triggers:spring-doc.cn

Path Type Description

calendarIntervalspring-doc.cn

Objectspring-doc.cn

Calendar interval trigger specific details.spring-doc.cn

calendarInterval.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, added to the fire time in order to calculate the time of the next trigger repeat.spring-doc.cn

calendarInterval.timeZonespring-doc.cn

Stringspring-doc.cn

Time zone within which time calculations will be performed, if any.spring-doc.cn

calendarInterval.timesTriggeredspring-doc.cn

Numberspring-doc.cn

Number of times the trigger has already fired.spring-doc.cn

calendarInterval.preserveHourOfDayAcrossDaylightSavingsspring-doc.cn

Booleanspring-doc.cn

Whether to fire the trigger at the same time of day, regardless of daylight saving time transitions.spring-doc.cn

calendarInterval.skipDayIfHourDoesNotExistspring-doc.cn

Booleanspring-doc.cn

Whether to skip if the hour of the day does not exist on a given day.spring-doc.cn

Custom Trigger Response Structure

A custom trigger is any other implementation. The resulting response for such a trigger implementation is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 457

{
  "group" : "samples",
  "name" : "example",
  "description" : "Example trigger.",
  "state" : "NORMAL",
  "type" : "custom",
  "calendarName" : "bankHolidays",
  "startTime" : "2020-11-30T17:00:00.000+00:00",
  "endTime" : "2020-12-30T03:00:00.000+00:00",
  "previousFireTime" : "2020-12-04T03:00:00.000+00:00",
  "nextFireTime" : "2020-12-07T03:00:00.000+00:00",
  "priority" : 10,
  "custom" : {
    "trigger" : "com.example.CustomTrigger@fdsfsd"
  }
}

Much of the response is common to all trigger types. The structure of the common elements of the response was described previously. The following table describes the structure of the parts of the response that are specific to custom triggers:spring-doc.cn

Path Type Description

customspring-doc.cn

Objectspring-doc.cn

Custom trigger specific details.spring-doc.cn

custom.triggerspring-doc.cn

Stringspring-doc.cn

A toString representation of the custom trigger instance.spring-doc.cn
Path Type Description

groupspring-doc.cn

Stringspring-doc.cn

Name of the group.spring-doc.cn

namespring-doc.cn

Stringspring-doc.cn

Name of the trigger.spring-doc.cn

descriptionspring-doc.cn

Stringspring-doc.cn

Description of the trigger, if any.spring-doc.cn

statespring-doc.cn

Stringspring-doc.cn

State of the trigger (NONE, NORMAL, PAUSED, COMPLETE, ERROR, BLOCKED).spring-doc.cn

typespring-doc.cn

Stringspring-doc.cn

Type of the trigger (calendarInterval, cron, custom, dailyTimeInterval, simple). Determines the key of the object containing type-specific details.spring-doc.cn

calendarNamespring-doc.cn

Stringspring-doc.cn

Name of the Calendar associated with this Trigger, if any.spring-doc.cn

startTimespring-doc.cn

Stringspring-doc.cn

Time at which the Trigger should take effect, if any.spring-doc.cn

endTimespring-doc.cn

Stringspring-doc.cn

Time at which the Trigger should quit repeating, regardless of any remaining repeats, if any.spring-doc.cn

previousFireTimespring-doc.cn

Stringspring-doc.cn

Last time the trigger fired, if any.spring-doc.cn

nextFireTimespring-doc.cn

Stringspring-doc.cn

Next time at which the Trigger is scheduled to fire, if any.spring-doc.cn

priorityspring-doc.cn

Numberspring-doc.cn

Priority to use if two triggers have the same scheduled fire time.spring-doc.cn

finalFireTimespring-doc.cn

Stringspring-doc.cn

Last time at which the Trigger will fire, if any.spring-doc.cn

dataspring-doc.cn

Objectspring-doc.cn

Job data map keyed by name, if any.spring-doc.cn

calendarIntervalspring-doc.cn

Objectspring-doc.cn

Calendar time interval trigger details, if any. Present when type is calendarInterval.spring-doc.cn

customspring-doc.cn

Objectspring-doc.cn

Custom trigger details, if any. Present when type is custom.spring-doc.cn

cronspring-doc.cn

Objectspring-doc.cn

Cron trigger details, if any. Present when type is cron.spring-doc.cn

dailyTimeIntervalspring-doc.cn

Objectspring-doc.cn

Daily time interval trigger details, if any. Present when type is dailyTimeInterval.spring-doc.cn

simplespring-doc.cn

Objectspring-doc.cn

Simple trigger details, if any. Present when type is simple.spring-doc.cn
Path Type Description

cronspring-doc.cn

Objectspring-doc.cn

Cron trigger specific details.spring-doc.cn

cron.expressionspring-doc.cn

Stringspring-doc.cn

Cron expression to use.spring-doc.cn

cron.timeZonespring-doc.cn

Stringspring-doc.cn

Time zone for which the expression will be resolved, if any.spring-doc.cn
Path Type Description

simplespring-doc.cn

Objectspring-doc.cn

Simple trigger specific details.spring-doc.cn

simple.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, between two executions.spring-doc.cn

simple.repeatCountspring-doc.cn

Numberspring-doc.cn

Number of times the trigger should repeat, or -1 to repeat indefinitely.spring-doc.cn

simple.timesTriggeredspring-doc.cn

Numberspring-doc.cn

Number of times the trigger has already fired.spring-doc.cn
Path Type Description

dailyTimeIntervalspring-doc.cn

Objectspring-doc.cn

Daily time interval trigger specific details.spring-doc.cn

dailyTimeInterval.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, added to the fire time in order to calculate the time of the next trigger repeat.spring-doc.cn

dailyTimeInterval.daysOfWeekspring-doc.cn

Arrayspring-doc.cn

An array of days of the week upon which to fire.spring-doc.cn

dailyTimeInterval.startTimeOfDayspring-doc.cn

Stringspring-doc.cn

Time of day to start firing at the given interval, if any.spring-doc.cn

dailyTimeInterval.endTimeOfDayspring-doc.cn

Stringspring-doc.cn

Time of day to complete firing at the given interval, if any.spring-doc.cn

dailyTimeInterval.repeatCountspring-doc.cn

Numberspring-doc.cn

Number of times the trigger should repeat, or -1 to repeat indefinitely.spring-doc.cn

dailyTimeInterval.timesTriggeredspring-doc.cn

Numberspring-doc.cn

Number of times the trigger has already fired.spring-doc.cn
Path Type Description

calendarIntervalspring-doc.cn

Objectspring-doc.cn

Calendar interval trigger specific details.spring-doc.cn

calendarInterval.intervalspring-doc.cn

Numberspring-doc.cn

Interval, in milliseconds, added to the fire time in order to calculate the time of the next trigger repeat.spring-doc.cn

calendarInterval.timeZonespring-doc.cn

Stringspring-doc.cn

Time zone within which time calculations will be performed, if any.spring-doc.cn

calendarInterval.timesTriggeredspring-doc.cn

Numberspring-doc.cn

Number of times the trigger has already fired.spring-doc.cn

calendarInterval.preserveHourOfDayAcrossDaylightSavingsspring-doc.cn

Booleanspring-doc.cn

Whether to fire the trigger at the same time of day, regardless of daylight saving time transitions.spring-doc.cn

calendarInterval.skipDayIfHourDoesNotExistspring-doc.cn

Booleanspring-doc.cn

Whether to skip if the hour of the day does not exist on a given day.spring-doc.cn
Path Type Description

customspring-doc.cn

Objectspring-doc.cn

Custom trigger specific details.spring-doc.cn

custom.triggerspring-doc.cn

Stringspring-doc.cn

A toString representation of the custom trigger instance.spring-doc.cn