uk.gov.gchq.gaffer.rest.controller.IJobController Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-rest Show documentation
There is a newer version: 2.3.1
/*
 * Copyright 2020-2022 Crown Copyright
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package uk.gov.gchq.gaffer.rest.controller;

import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import uk.gov.gchq.gaffer.jobtracker.Job;
import uk.gov.gchq.gaffer.jobtracker.JobDetail;
import uk.gov.gchq.gaffer.operation.Operation;
import uk.gov.gchq.gaffer.operation.OperationException;

import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;

@Tag(name = "job")
@RequestMapping("/graph/jobs")
public interface IJobController {

    @PostMapping(
            consumes = APPLICATION_JSON_VALUE,
            produces = APPLICATION_JSON_VALUE
    )
    @io.swagger.v3.oas.annotations.Operation(
            summary = "Kicks off an asynchronous job"
    )
    ResponseEntity startJob(final Operation operation) throws OperationException;

    @PostMapping(
            path = "/schedule",
            consumes = APPLICATION_JSON_VALUE,
            produces = APPLICATION_JSON_VALUE
    )
    @io.swagger.v3.oas.annotations.Operation(
            summary = "schedules an asynchronous job"
    )
    ResponseEntity scheduleJob(final Job job) throws OperationException;

    @GetMapping(
            path = "/{id}",
            produces = APPLICATION_JSON_VALUE
    )
    @io.swagger.v3.oas.annotations.Operation(
            summary = "Retrieves the details of an asynchronous job"
    )
    JobDetail getDetails(final String id) throws OperationException;

    @GetMapping(
            produces = APPLICATION_JSON_VALUE
    )
    @io.swagger.v3.oas.annotations.Operation(
            summary = "Retrieves the details of all the asynchronous jobs"
    )
    Iterable getAllDetails() throws OperationException;

    @GetMapping(
            path = "/{id}/results",
            produces = APPLICATION_JSON_VALUE
    )
    @io.swagger.v3.oas.annotations.Operation(
            summary = "Retrieves the results of an asynchronous job"
    )
    Object getResults(final String id) throws OperationException;
}