org.apache.flink.runtime.rest.messages.job.metrics.ComponentsMetricCollectionResponseBody 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.messages.ResponseBody;

import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.JsonGenerator;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.JsonParser;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.type.TypeReference;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.DeserializationContext;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.SerializerProvider;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.annotation.JsonSerialize;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ser.std.StdSerializer;

import java.io.IOException;
import java.util.Collection;
import java.util.List;

import static java.util.Objects.requireNonNull;

/**
 * Response type for a collection of metrics.
 *
 * As JSON this type will be represented as an array of
 * metrics, i.e., the field metrics will not show up. For example, a collection with a
 * single metric will be represented as follows:
 * 
 * {@code
 * [{"component-id": "X","timestamp": 1546663652843, "metrics": [{ "id" : "X", "value" : "S" }, { "id" : "Y", "value" : "T" }]}]
 * }
 * 
 *
 * @see Serializer
 * @see Deserializer
 * @see org.apache.flink.runtime.rest.handler.legacy.metrics.MetricStore
 */
@JsonSerialize(using = ComponentsMetricCollectionResponseBody.Serializer.class)
@JsonDeserialize(using = ComponentsMetricCollectionResponseBody.Deserializer.class)
public final class ComponentsMetricCollectionResponseBody implements ResponseBody {

	private final Collection componentMetrics;

	public ComponentsMetricCollectionResponseBody(Collection componentMetrics) {
		this.componentMetrics = requireNonNull(componentMetrics, "component metrics must not be null");
	}

	public Collection getComponentMetrics() {
		return componentMetrics;
	}

	/**
	 * JSON serializer for {@link ComponentsMetricCollectionResponseBody}.
	 */
	public static class Serializer extends StdSerializer {

		private static final long serialVersionUID = 1L;

		protected Serializer() {
			super(ComponentsMetricCollectionResponseBody.class);
		}

		@Override
		public void serialize(
				ComponentsMetricCollectionResponseBody metricCollectionResponseBody,
				JsonGenerator jsonGenerator,
				SerializerProvider serializerProvider) throws IOException {

			jsonGenerator.writeObject(metricCollectionResponseBody.getComponentMetrics());
		}
	}

	/**
	 * JSON deserializer for {@link ComponentsMetricCollectionResponseBody}.
	 */
	public static class Deserializer extends StdDeserializer {

		private static final long serialVersionUID = 1L;

		protected Deserializer() {
			super(ComponentsMetricCollectionResponseBody.class);
		}

		@Override
		public ComponentsMetricCollectionResponseBody deserialize(
				JsonParser jsonParser,
				DeserializationContext deserializationContext) throws IOException {

			return new ComponentsMetricCollectionResponseBody(jsonParser.readValueAs(
				new TypeReference>() {
				}));
		}
	}

}