com.netflix.genie.web.services

Interface JobCoordinatorService

All Known Implementing Classes:

JobCoordinatorServiceImpl

@Validated
public interface JobCoordinatorService

Job Coordination APIs.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	coordinateJob(@NotNull(message="No job request provided. Unable to execute.") @Valid com.netflix.genie.common.dto.JobRequest jobRequest, @NotNull(message="No job metadata provided. Unable to execute.") @Valid com.netflix.genie.common.dto.JobMetadata jobMetadata) Takes in a Job Request object and does necessary preparation for execution.
void	killJob(@NotBlank java.lang.String jobId, @NotBlank java.lang.String reason) Kill the job identified by the given id.

Method Detail

coordinateJob

java.lang.String coordinateJob(@NotNull(message="No job request provided. Unable to execute.") @Valid
                               @NotNull(message="No job request provided. Unable to execute.") @Valid com.netflix.genie.common.dto.JobRequest jobRequest,
                               @NotNull(message="No job metadata provided. Unable to execute.") @Valid
                               @NotNull(message="No job metadata provided. Unable to execute.") @Valid com.netflix.genie.common.dto.JobMetadata jobMetadata)
                        throws com.netflix.genie.common.exceptions.GenieException

Takes in a Job Request object and does necessary preparation for execution.

Parameters:

jobRequest - of job to kill

jobMetadata - Metadata about the http request which generated started this job process

Returns:

the id of the job run

Throws:

com.netflix.genie.common.exceptions.GenieException - if there is an error

killJob

void killJob(@NotBlank
             @NotBlank java.lang.String jobId,
             @NotBlank
             @NotBlank java.lang.String reason)
      throws com.netflix.genie.common.exceptions.GenieException

Kill the job identified by the given id.

Parameters:

jobId - id of the job to kill

reason - brief reason for requesting the job be killed

Throws:

com.netflix.genie.common.exceptions.GenieException - if there is an error