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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
The 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.rest.handler.job.JobExceptionsHandler;
import org.apache.flink.util.Preconditions;

import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;

import java.util.List;
import java.util.Objects;

/**
 * Response type of the {@link JobExceptionsHandler}.
 */
public class JobExceptionsInfo implements ResponseBody {

	public static final String FIELD_NAME_ROOT_EXCEPTION = "root-exception";
	public static final String FIELD_NAME_TIMESTAMP = "timestamp";
	public static final String FIELD_NAME_ALL_EXCEPTIONS = "all-exceptions";
	public static final String FIELD_NAME_TRUNCATED = "truncated";

	@JsonProperty(FIELD_NAME_ROOT_EXCEPTION)
	private final String rootException;

	@JsonProperty(FIELD_NAME_TIMESTAMP)
	private final Long rootTimestamp;

	@JsonProperty(FIELD_NAME_ALL_EXCEPTIONS)
	private final List allExceptions;

	@JsonProperty(FIELD_NAME_TRUNCATED)
	private final boolean truncated;

	@JsonCreator
	public JobExceptionsInfo(
		@JsonProperty(FIELD_NAME_ROOT_EXCEPTION) String rootException,
		@JsonProperty(FIELD_NAME_TIMESTAMP) Long rootTimestamp,
		@JsonProperty(FIELD_NAME_ALL_EXCEPTIONS) List allExceptions,
		@JsonProperty(FIELD_NAME_TRUNCATED) boolean truncated) {
		this.rootException = rootException;
		this.rootTimestamp = rootTimestamp;
		this.allExceptions = Preconditions.checkNotNull(allExceptions);
		this.truncated = truncated;
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		if (o == null || getClass() != o.getClass()) {
			return false;
		}
		JobExceptionsInfo that = (JobExceptionsInfo) o;
		return truncated == that.truncated &&
			Objects.equals(rootException, that.rootException) &&
			Objects.equals(rootTimestamp, that.rootTimestamp) &&
			Objects.equals(allExceptions, that.allExceptions);
	}

	@Override
	public int hashCode() {
		return Objects.hash(rootException, rootTimestamp, allExceptions, truncated);
	}

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

	/**
	 * Nested class to encapsulate the task execution exception.
	 * Sorted by timestamp field ASC ordering.
	 */
	public static final class ExecutionExceptionInfo implements Comparable {
		public static final String FIELD_NAME_EXCEPTION = "exception";
		public static final String FIELD_NAME_TASK = "task";
		public static final String FIELD_NAME_LOCATION = "location";
		public static final String FIELD_NAME_TIMESTAMP = "timestamp";
		public static final String FIELD_NAME_VERTEX_ID = "vertex-id";
		public static final String FIELD_NAME_SUBTASK_INDEX = "subtask-index";
		public static final String FIELD_NAME_ATTEMPT_NUM = "attempt-num";

		@JsonProperty(FIELD_NAME_EXCEPTION)
		private final String exception;

		@JsonProperty(FIELD_NAME_TASK)
		private final String task;

		@JsonProperty(FIELD_NAME_LOCATION)
		private final String location;

		@JsonProperty(FIELD_NAME_TIMESTAMP)
		private final long timestamp;

		@JsonProperty(FIELD_NAME_VERTEX_ID)
		private final String vertexID;

		@JsonProperty(FIELD_NAME_SUBTASK_INDEX)
		private final int subtaskIndex;

		@JsonProperty(FIELD_NAME_ATTEMPT_NUM)
		private final int attemptNum;

		@JsonCreator
		public ExecutionExceptionInfo(
			@JsonProperty(FIELD_NAME_EXCEPTION) String exception,
			@JsonProperty(FIELD_NAME_TASK) String task,
			@JsonProperty(FIELD_NAME_LOCATION) String location,
			@JsonProperty(FIELD_NAME_TIMESTAMP) long timestamp,
			@JsonProperty(FIELD_NAME_VERTEX_ID) String vertexID,
			@JsonProperty(FIELD_NAME_SUBTASK_INDEX) int subtaskIndex,
			@JsonProperty(FIELD_NAME_ATTEMPT_NUM) int attemptNum) {

			this.exception = Preconditions.checkNotNull(exception);
			this.task = Preconditions.checkNotNull(task);
			this.location = Preconditions.checkNotNull(location);
			this.timestamp = timestamp;
			this.vertexID = vertexID;
			this.subtaskIndex = subtaskIndex;
			this.attemptNum = attemptNum;
		}

		@Override
		public boolean equals(Object o) {
			if (this == o) {
				return true;
			}
			if (o == null || getClass() != o.getClass()) {
				return false;
			}
			JobExceptionsInfo.ExecutionExceptionInfo that = (JobExceptionsInfo.ExecutionExceptionInfo) o;
			return timestamp == that.timestamp &&
				Objects.equals(exception, that.exception) &&
				Objects.equals(task, that.task) &&
				Objects.equals(location, that.location) &&
				Objects.equals(vertexID, that.vertexID) &&
				subtaskIndex == that.subtaskIndex &&
				attemptNum == that.attemptNum;
		}

		@Override
		public int hashCode() {
			return Objects.hash(timestamp, exception, task, location, vertexID, subtaskIndex, attemptNum);
		}

		@Override
		public int compareTo(ExecutionExceptionInfo o) {
			return Long.compare(timestamp, o.timestamp);
		}
	}
}