zentol commented on a change in pull request #8052: [FLINK-11458][checkpointing, rest] Add TERMINATE/SUSPEND Job with Savepoint (FLIP-34) URL: https://github.com/apache/flink/pull/8052#discussion_r271691837
########## File path: flink-runtime/src/main/java/org/apache/flink/runtime/rest/messages/job/savepoints/stop/StopWithSavepointTriggerHeaders.java ########## @@ -0,0 +1,84 @@ +/* + * 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.job.savepoints.stop; + +import org.apache.flink.runtime.rest.HttpMethodWrapper; +import org.apache.flink.runtime.rest.handler.async.AsynchronousOperationTriggerMessageHeaders; +import org.apache.flink.runtime.rest.messages.JobIDPathParameter; + +import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus; + +/** + * These headers define the protocol for triggering a "stop-with-savepoint" action. + */ +public class StopWithSavepointTriggerHeaders + extends AsynchronousOperationTriggerMessageHeaders<StopWithSavepointRequestBody, StopWithSavepointMessageParameters> { + + private static final StopWithSavepointTriggerHeaders INSTANCE = new StopWithSavepointTriggerHeaders(); + + private static final String URL = String.format( + "/jobs/:%s/stop-with-savepoint", + JobIDPathParameter.KEY); + + private StopWithSavepointTriggerHeaders() { + } + + @Override + public Class<StopWithSavepointRequestBody> getRequestClass() { + return StopWithSavepointRequestBody.class; + } + + @Override + public HttpResponseStatus getResponseStatusCode() { + return HttpResponseStatus.ACCEPTED; + } + + @Override + public StopWithSavepointMessageParameters getUnresolvedMessageParameters() { + return new StopWithSavepointMessageParameters(); + } + + @Override + public HttpMethodWrapper getHttpMethod() { + return HttpMethodWrapper.POST; + } + + @Override + public String getTargetRestEndpointURL() { + /* + Note: this is different to the existing implementation for which the targetDirectory is a path parameter + Having it as a path parameter has several downsides as it + - is optional (which we only allow for query parameters) + - causes parsing issues, since the path is not reliably treated as a single parameter + - does not denote a hierarchy which path parameters are supposed to do + - interacts badly with the POST spec, as it would require the progress url to also contain the targetDirectory + */ + + return URL; + } + + public static StopWithSavepointTriggerHeaders getInstance() { + return INSTANCE; + } + + @Override + public String getDescription() { + return "Triggers a savepoint, and optionally cancels the job afterwards."; Review comment: out-dated? (cancel vs stop, stop isn't optional, missing explanation of `end-of-time` field) ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
