org.apache.flink.runtime.rest.messages.job.SubtaskExecutionAttemptAccumulatorsHeaders Maven / Gradle / Ivy
/*
* 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;
import org.apache.flink.runtime.rest.HttpMethodWrapper;
import org.apache.flink.runtime.rest.handler.job.SubtaskExecutionAttemptAccumulatorsHandler;
import org.apache.flink.runtime.rest.messages.EmptyRequestBody;
import org.apache.flink.runtime.rest.messages.JobIDPathParameter;
import org.apache.flink.runtime.rest.messages.JobVertexIdPathParameter;
import org.apache.flink.runtime.rest.messages.MessageHeaders;
import org.apache.flink.runtime.rest.messages.SubtaskIndexPathParameter;
import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus;
/**
* Message headers for the {@link SubtaskExecutionAttemptAccumulatorsHandler}.
*/
public class SubtaskExecutionAttemptAccumulatorsHeaders implements MessageHeaders {
private static final SubtaskExecutionAttemptAccumulatorsHeaders INSTANCE = new SubtaskExecutionAttemptAccumulatorsHeaders();
public static final String URL = String.format(
"/jobs/:%s/vertices/:%s/subtasks/:%s/attempts/:%s/accumulators",
JobIDPathParameter.KEY,
JobVertexIdPathParameter.KEY,
SubtaskIndexPathParameter.KEY,
SubtaskAttemptPathParameter.KEY);
@Override
public HttpMethodWrapper getHttpMethod() {
return HttpMethodWrapper.GET;
}
@Override
public String getTargetRestEndpointURL() {
return URL;
}
@Override
public Class getRequestClass() {
return EmptyRequestBody.class;
}
@Override
public Class getResponseClass() {
return SubtaskExecutionAttemptAccumulatorsInfo.class;
}
@Override
public HttpResponseStatus getResponseStatusCode() {
return HttpResponseStatus.OK;
}
@Override
public SubtaskAttemptMessageParameters getUnresolvedMessageParameters() {
return new SubtaskAttemptMessageParameters();
}
public static SubtaskExecutionAttemptAccumulatorsHeaders getInstance() {
return INSTANCE;
}
@Override
public String getDescription() {
return "Returns the accumulators of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.";
}
}