org.apache.flink.runtime.rest.messages.job.metrics.SubtaskMetricsHeaders 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.metrics;
import org.apache.flink.runtime.rest.handler.job.metrics.SubtaskMetricsHandler;
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;
/**
* {@link MessageHeaders} for {@link SubtaskMetricsHandler}.
*/
public final class SubtaskMetricsHeaders extends
AbstractMetricsHeaders {
private static final SubtaskMetricsHeaders INSTANCE = new SubtaskMetricsHeaders();
private SubtaskMetricsHeaders() {
}
@Override
public SubtaskMetricsMessageParameters getUnresolvedMessageParameters() {
return new SubtaskMetricsMessageParameters();
}
@Override
public String getTargetRestEndpointURL() {
return "/jobs/:" + JobIDPathParameter.KEY + "/vertices/:" + JobVertexIdPathParameter.KEY +
"/subtasks/:" + SubtaskIndexPathParameter.KEY + "/metrics";
}
public static SubtaskMetricsHeaders getInstance() {
return INSTANCE;
}
@Override
public String getDescription() {
return "Provides access to subtask metrics.";
}
}