Package org.springframework.cloud.dataflow.rest.client

Interface JobOperations

All Known Implementing Classes:
JobTemplate
public interface JobOperations
Interface defining operations available for jobs.
Author:
Glenn Renfro

  • Method Details

    • executionList

      org.springframework.hateoas.PagedModel<JobExecutionResource> executionList()
      Returns:
      the list job executions known to the system.

    • executionRestart

      void executionRestart(long id)
      Restarts a job by id
      Parameters:
      id - job execution id

    • executionRestart

      void executionRestart(long id, Boolean useJsonJobParameters)
      Restarts a job by id
      Parameters:
      id - job execution id
      useJsonJobParameters - if true JobParameters will be serialized to JSON. Default is Null which will serialize the JobParameters to the default specified in SCDF's configuration.

    • executionThinList

      org.springframework.hateoas.PagedModel<JobExecutionThinResource> executionThinList()
      Returns:
      the list job executions without step executions known to the system.

    • instanceList

      org.springframework.hateoas.PagedModel<JobInstanceResource> instanceList(String jobName)
      Parameters:
      jobName - the name of the job
      Returns:
      the list job instances for the specified jobName.

    • executionThinListByJobName

      org.springframework.hateoas.PagedModel<JobExecutionThinResource> executionThinListByJobName(String jobName)
      List job executions without step executions known to the system filtered by job name.
      Parameters:
      jobName - of the executions.
      Returns:
      the list of job executions

    • executionListByJobName

      org.springframework.hateoas.PagedModel<JobExecutionResource> executionListByJobName(String jobName)
      List job executions known to the system filtered by job name.
      Parameters:
      jobName - of the executions.
      Returns:
      the list of job executions

    • jobExecution

      JobExecutionResource jobExecution(long id)
      Return the JobExecutionResource for the id specified.
      Parameters:
      id - identifier of the job execution
      Returns:
      JobExecutionResource

    • jobInstance

      JobInstanceResource jobInstance(long id)
      Return the JobInstanceResource for the id specified.
      Parameters:
      id - identifier of the job instance
      Returns:
      JobInstanceResource

    • stepExecutionList

      org.springframework.hateoas.PagedModel<StepExecutionResource> stepExecutionList(long jobExecutionId)
      List step executions known for a specific job execution id.
      Parameters:
      jobExecutionId - the id of the job execution.
      Returns:
      the paged list of step executions

    • stepExecutionProgress

      StepExecutionProgressInfoResource stepExecutionProgress(long jobExecutionId, long stepExecutionId)
      Return StepExecutionProgressInfoResource for a specific job execution id and step execution Id.
      Parameters:
      jobExecutionId - the id of the job execution for the step to be returned.
      stepExecutionId - the id step execution to be returned.
      Returns:
      the step execution progress info