flink-runtime/src/main/java/org/apache/flink/runtime/rest/messages/JobClientHeartbeatHeaders.java

/*
 * 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.JobClientHeartbeatHandler;

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

/** Message headers for the {@link JobClientHeartbeatHandler}. */
public class JobClientHeartbeatHeaders
        implements RuntimeMessageHeaders<
                JobClientHeartbeatRequestBody, EmptyResponseBody, JobClientHeartbeatParameters> {

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

    private static final JobClientHeartbeatHeaders INSTANCE = new JobClientHeartbeatHeaders();

    private JobClientHeartbeatHeaders() {}

    @Override
    public Class<JobClientHeartbeatRequestBody> getRequestClass() {
        return JobClientHeartbeatRequestBody.class;
    }

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

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

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

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

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

    public static JobClientHeartbeatHeaders getInstance() {
        return INSTANCE;
    }

    @Override
    public String getDescription() {
        return "Report the jobClient's aliveness.";
    }

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