All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.flink.runtime.rest.messages.JobGraphOverviewInfo Maven / Gradle / Ivy

There is a newer version: 1.5.1
Show newest version
/*
 * 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.jobgraph.JobVertexID;
import org.apache.flink.runtime.rest.handler.job.JobGraphOverviewHandler;
import org.apache.flink.runtime.rest.messages.json.AbstractIDDeserializer;
import org.apache.flink.runtime.rest.messages.json.AbstractIDSerializer;
import org.apache.flink.runtime.rest.messages.json.JobVertexIDDeserializer;
import org.apache.flink.runtime.rest.messages.json.JobVertexIDSerializer;
import org.apache.flink.util.AbstractID;

import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonIgnore;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;
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 java.util.List;
import java.util.Map;
import java.util.Objects;

import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * Response type of the {@link JobGraphOverviewHandler}.
 */
public class JobGraphOverviewInfo implements ResponseBody {
	public static final String FIELD_NAME_JOB_CONFIG = "config";
	public static final String FIELD_NAME_VERTEX_CONFIG = "vertex-config";
	public static final String FIELD_NAME_INPUT_NODES = "input-nodes";

	@JsonProperty(FIELD_NAME_JOB_CONFIG)
	private final Map config;

	@JsonProperty(FIELD_NAME_VERTEX_CONFIG)
	private final Map vertexConfigs;

	@JsonProperty(FIELD_NAME_INPUT_NODES)
	private final Map> inputNodes;

	@JsonCreator
	public JobGraphOverviewInfo(
			@JsonProperty(FIELD_NAME_JOB_CONFIG) Map config,
			@JsonProperty(FIELD_NAME_VERTEX_CONFIG) Map vertexConfigs,
			@JsonProperty(FIELD_NAME_INPUT_NODES) Map> inputNodes) {
		this.config = config;
		this.vertexConfigs = vertexConfigs;
		this.inputNodes = inputNodes;
	}

	public Map getConfig() {
		return config;
	}

	public Map getVertexConfigs() {
		return vertexConfigs;
	}

	public Map> getInputNodes() {
		return inputNodes;
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}

		if (null == o || this.getClass() != o.getClass()) {
			return false;
		}

		JobGraphOverviewInfo that = (JobGraphOverviewInfo) o;
		return Objects.equals(config, that.config) &&
			Objects.equals(vertexConfigs, that.vertexConfigs) &&
			Objects.equals(inputNodes, that.inputNodes);
	}

	@Override
	public int hashCode() {
		return Objects.hash(config, vertexConfigs, inputNodes);
	}

	//---------------------------------------------------------------------------------
	// Static helper classes
	//---------------------------------------------------------------------------------

	/**
	 * Vertex config class.
	 */
	public static final class VertexConfigInfo {
		public static final String FIELD_NAME_VERTEX_ID = "id";
		public static final String FIELD_NAME_VERTEX_NAME = "name";
		public static final String FIELD_NAME_PARALLELISM = "parallelism";
		public static final String FIELD_NAME_MAX_PARALLELISM = "max-parallelism";
		public static final String FIELD_NAME_RESOURCE_SPEC = "resource-spec";
		public static final String FIELD_NAME_NODE_IDS = "nodeIds";
		public static final String FIELD_NAME_COLOCATION_GROUP_ID = "co-location_id";

		@JsonProperty(FIELD_NAME_VERTEX_ID)
		@JsonSerialize(using = JobVertexIDSerializer.class)
		private final JobVertexID id;

		@JsonProperty(FIELD_NAME_VERTEX_NAME)
		private final String name;

		@JsonProperty(FIELD_NAME_PARALLELISM)
		private final int parallelism;

		@JsonProperty(FIELD_NAME_MAX_PARALLELISM)
		private final int maxParallelism;

		@JsonProperty(FIELD_NAME_RESOURCE_SPEC)
		private final ResourceSpecInfo resourceSpec;

		@JsonProperty(FIELD_NAME_NODE_IDS)
		private final List nodeIds;

		@JsonProperty(FIELD_NAME_COLOCATION_GROUP_ID)
		@JsonSerialize(using = AbstractIDSerializer.class)
		private final AbstractID coLocationGroupId;

		@JsonCreator
		public VertexConfigInfo(
			@JsonDeserialize(using = JobVertexIDDeserializer.class) @JsonProperty(FIELD_NAME_VERTEX_ID) JobVertexID id,
			@JsonProperty(FIELD_NAME_VERTEX_NAME) String name,
			@JsonProperty(FIELD_NAME_PARALLELISM) int parallelism,
			@JsonProperty(FIELD_NAME_MAX_PARALLELISM) int maxParallelism,
			@JsonProperty(FIELD_NAME_RESOURCE_SPEC) ResourceSpecInfo resourceSpec,
			@JsonProperty(FIELD_NAME_NODE_IDS) List nodeIds,
			@JsonProperty(FIELD_NAME_COLOCATION_GROUP_ID) @JsonDeserialize(using = AbstractIDDeserializer.class)
				AbstractID coLocationGroupId) {
			this.id = checkNotNull(id);
			this.name = checkNotNull(name);
			this.parallelism = parallelism;
			this.maxParallelism = maxParallelism;
			this.resourceSpec = resourceSpec;
			this.nodeIds = nodeIds;
			this.coLocationGroupId = coLocationGroupId;
		}

		@JsonIgnore
		public JobVertexID getId() {
			return id;
		}

		@JsonIgnore
		public String getName() {
			return name;
		}

		@JsonIgnore
		public int getParallelism() {
			return parallelism;
		}

		@JsonIgnore
		public int getMaxParallelism() {
			return maxParallelism;
		}

		@JsonIgnore
		public ResourceSpecInfo getResourceSpec() {
			return resourceSpec;
		}

		@JsonIgnore
		public List getNodeIds() {
			return nodeIds;
		}

		@JsonIgnore
		public AbstractID getCoLocationGroupId() {
			return coLocationGroupId;
		}

		@Override
		public boolean equals(Object o) {
			if (this == o) {
				return true;
			}

			if (null == o || this.getClass() != o.getClass()) {
				return false;
			}

			VertexConfigInfo that = (VertexConfigInfo) o;
			return Objects.equals(id, that.id) &&
				Objects.equals(name, that.name) &&
				parallelism == that.parallelism &&
				Objects.equals(resourceSpec, that.resourceSpec) &&
				Objects.equals(nodeIds, that.nodeIds) &&
				Objects.equals(coLocationGroupId, that.coLocationGroupId);
		}

		@Override
		public int hashCode() {
			return Objects.hash(id, name, parallelism, resourceSpec, nodeIds, coLocationGroupId);
		}
	}

	/**
	 *
	 */
	public static final class EdgeConfigInfo {
		public static final String FIELD_NAME_INPUT_VERTEX_ID = "input-vertex-id";
		public static final String FIELD_NAME_SHIP_STRATEGY_NAME = "ship-strategy-name";

		@JsonProperty(FIELD_NAME_INPUT_VERTEX_ID)
		private final String inputVertexId;

		@JsonProperty(FIELD_NAME_SHIP_STRATEGY_NAME)
		private final String shipStrategyName;

		@JsonCreator
		public EdgeConfigInfo(
			@JsonProperty(FIELD_NAME_INPUT_VERTEX_ID) String inputVertexId,
			@JsonProperty(FIELD_NAME_SHIP_STRATEGY_NAME) String shipStrategyName) {
			this.inputVertexId = inputVertexId;
			this.shipStrategyName = shipStrategyName;
		}

		@JsonIgnore
		public String getInputVertexId() {
			return inputVertexId;
		}

		@JsonIgnore
		public String getShipStrategyName() {
			return shipStrategyName;
		}

		@Override
		public boolean equals(Object o) {
			if (this == o) {
				return true;
			}

			if (null == o || this.getClass() != o.getClass()) {
				return false;
			}

			EdgeConfigInfo that = (EdgeConfigInfo) o;
			return Objects.equals(inputVertexId, that.inputVertexId) &&
				Objects.equals(shipStrategyName, that.shipStrategyName);
		}

		@Override
		public int hashCode() {
			return Objects.hash(inputVertexId, shipStrategyName);
		}
	}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy