org.apache.flink.runtime.rest.messages.JobCancellationHeaders Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-runtime Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.flink.runtime.rest.messages;

import org.apache.flink.runtime.rest.HttpMethodWrapper;
import org.apache.flink.runtime.rest.handler.job.JobCancellationHandler;

import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus;

/** Message headers for the {@link JobCancellationHandler}. */
public class JobCancellationHeaders
        implements RuntimeMessageHeaders<
                EmptyRequestBody, EmptyResponseBody, JobCancellationMessageParameters> {

    public static final String URL = "/jobs/:jobid";

    private static final JobCancellationHeaders INSTANCE = new JobCancellationHeaders();

    private JobCancellationHeaders() {}

    @Override
    public Class getRequestClass() {
        return EmptyRequestBody.class;
    }

    @Override
    public Class getResponseClass() {
        return EmptyResponseBody.class;
    }

    @Override
    public HttpResponseStatus getResponseStatusCode() {
        return HttpResponseStatus.ACCEPTED;
    }

    @Override
    public JobCancellationMessageParameters getUnresolvedMessageParameters() {
        return new JobCancellationMessageParameters();
    }

    @Override
    public HttpMethodWrapper getHttpMethod() {
        return HttpMethodWrapper.PATCH;
    }

    @Override
    public String getTargetRestEndpointURL() {
        return URL;
    }

    public static JobCancellationHeaders getInstance() {
        return INSTANCE;
    }

    @Override
    public String getDescription() {
        return "Terminates a job.";
    }

    @Override
    public String operationId() {
        return "cancelJob";
    }
}