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

org.apache.flink.runtime.messages.webmonitor.JobDetails Maven / Gradle / Ivy

There is a newer version: 1.13.6
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.messages.webmonitor;

import org.apache.flink.api.common.JobID;
import org.apache.flink.api.common.JobStatus;
import org.apache.flink.runtime.execution.ExecutionState;
import org.apache.flink.util.Preconditions;

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.databind.DeserializationContext;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.JsonNode;
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.io.Serializable;
import java.util.Arrays;

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

/**
 * An actor message with a detailed overview of the current status of a job.
 */
@JsonSerialize(using = JobDetails.JobDetailsSerializer.class)
@JsonDeserialize(using = JobDetails.JobDetailsDeserializer.class)
public class JobDetails implements Serializable {

	private static final long serialVersionUID = -3391462110304948766L;

	private static final String FIELD_NAME_JOB_ID = "jid";
	private static final String FIELD_NAME_JOB_NAME = "name";
	private static final String FIELD_NAME_START_TIME = "start-time";
	private static final String FIELD_NAME_END_TIME = "end-time";
	private static final String FIELD_NAME_DURATION = "duration";
	private static final String FIELD_NAME_STATUS = "state";
	private static final String FIELD_NAME_LAST_MODIFICATION = "last-modification";
	private static final String FIELD_NAME_TOTAL_NUMBER_TASKS = "total";

	private final JobID jobId;

	private final String jobName;

	private final long startTime;

	private final long endTime;

	private final long duration;

	private final JobStatus status;

	private final long lastUpdateTime;

	private final int[] tasksPerState;
	
	private final int numTasks;

	public JobDetails(
			JobID jobId,
			String jobName,
			long startTime,
			long endTime,
			long duration,
			JobStatus status,
			long lastUpdateTime,
			int[] tasksPerState,
			int numTasks) {

		this.jobId = checkNotNull(jobId);
		this.jobName = checkNotNull(jobName);
		this.startTime = startTime;
		this.endTime = endTime;
		this.duration = duration;
		this.status = checkNotNull(status);
		this.lastUpdateTime = lastUpdateTime;
		Preconditions.checkArgument(tasksPerState.length == ExecutionState.values().length, 
			"tasksPerState argument must be of size %s.", ExecutionState.values().length);
		this.tasksPerState = checkNotNull(tasksPerState);
		this.numTasks = numTasks;
	}
	
	// ------------------------------------------------------------------------

	public JobID getJobId() {
		return jobId;
	}

	public String getJobName() {
		return jobName;
	}

	public long getStartTime() {
		return startTime;
	}

	public long getEndTime() {
		return endTime;
	}

	public long getDuration() {
		return duration;
	}

	public JobStatus getStatus() {
		return status;
	}

	public long getLastUpdateTime() {
		return lastUpdateTime;
	}

	public int getNumTasks() {
		return numTasks;
	}

	public int[] getTasksPerState() {
		return tasksPerState;
	}

	// ------------------------------------------------------------------------

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		else if (o != null && o.getClass() == JobDetails.class) {
			JobDetails that = (JobDetails) o;

			return this.endTime == that.endTime &&
					this.lastUpdateTime == that.lastUpdateTime &&
					this.numTasks == that.numTasks &&
					this.startTime == that.startTime &&
					this.status == that.status &&
					this.jobId.equals(that.jobId) &&
					this.jobName.equals(that.jobName) &&
					Arrays.equals(this.tasksPerState, that.tasksPerState);
		}
		else {
			return false;
		}
	}

	@Override
	public int hashCode() {
		int result = jobId.hashCode();
		result = 31 * result + jobName.hashCode();
		result = 31 * result + (int) (startTime ^ (startTime >>> 32));
		result = 31 * result + (int) (endTime ^ (endTime >>> 32));
		result = 31 * result + status.hashCode();
		result = 31 * result + (int) (lastUpdateTime ^ (lastUpdateTime >>> 32));
		result = 31 * result + Arrays.hashCode(tasksPerState);
		result = 31 * result + numTasks;
		return result;
	}

	@Override
	public String toString() {
		return "JobDetails {" +
				"jobId=" + jobId +
				", jobName='" + jobName + '\'' +
				", startTime=" + startTime +
				", endTime=" + endTime +
				", status=" + status +
				", lastUpdateTime=" + lastUpdateTime +
				", numVerticesPerExecutionState=" + Arrays.toString(tasksPerState) +
				", numTasks=" + numTasks +
				'}';
	}

	public static final class JobDetailsSerializer extends StdSerializer {
		private static final long serialVersionUID = 7915913423515194428L;

		public JobDetailsSerializer() {
			super(JobDetails.class);
		}

		@Override
		public void serialize(
				JobDetails jobDetails,
				JsonGenerator jsonGenerator,
				SerializerProvider serializerProvider) throws IOException {
			jsonGenerator.writeStartObject();

			jsonGenerator.writeStringField(FIELD_NAME_JOB_ID, jobDetails.getJobId().toString());
			jsonGenerator.writeStringField(FIELD_NAME_JOB_NAME, jobDetails.getJobName());
			jsonGenerator.writeStringField(FIELD_NAME_STATUS, jobDetails.getStatus().name());

			jsonGenerator.writeNumberField(FIELD_NAME_START_TIME, jobDetails.getStartTime());
			jsonGenerator.writeNumberField(FIELD_NAME_END_TIME, jobDetails.getEndTime());
			jsonGenerator.writeNumberField(FIELD_NAME_DURATION, jobDetails.getDuration());
			jsonGenerator.writeNumberField(FIELD_NAME_LAST_MODIFICATION, jobDetails.getLastUpdateTime());

			jsonGenerator.writeObjectFieldStart("tasks");
			jsonGenerator.writeNumberField(FIELD_NAME_TOTAL_NUMBER_TASKS, jobDetails.getNumTasks());

			final int[] perState = jobDetails.getTasksPerState();

			for (ExecutionState executionState : ExecutionState.values()) {
				jsonGenerator.writeNumberField(executionState.name().toLowerCase(), perState[executionState.ordinal()]);
			}

			jsonGenerator.writeEndObject();

			jsonGenerator.writeEndObject();
		}
	}

	public static final class JobDetailsDeserializer extends StdDeserializer {

		private static final long serialVersionUID = 6089784742093294800L;

		public JobDetailsDeserializer() {
			super(JobDetails.class);
		}

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

			JsonNode rootNode = jsonParser.readValueAsTree();

			JobID jobId = JobID.fromHexString(rootNode.get(FIELD_NAME_JOB_ID).textValue());
			String jobName = rootNode.get(FIELD_NAME_JOB_NAME).textValue();
			long startTime = rootNode.get(FIELD_NAME_START_TIME).longValue();
			long endTime = rootNode.get(FIELD_NAME_END_TIME).longValue();
			long duration = rootNode.get(FIELD_NAME_DURATION).longValue();
			JobStatus jobStatus = JobStatus.valueOf(rootNode.get(FIELD_NAME_STATUS).textValue());
			long lastUpdateTime = rootNode.get(FIELD_NAME_LAST_MODIFICATION).longValue();

			JsonNode tasksNode = rootNode.get("tasks");
			int numTasks = tasksNode.get(FIELD_NAME_TOTAL_NUMBER_TASKS).intValue();

			int[] numVerticesPerExecutionState = new int[ExecutionState.values().length];

			for (ExecutionState executionState : ExecutionState.values()) {
				numVerticesPerExecutionState[executionState.ordinal()] = tasksNode.get(executionState.name().toLowerCase()).intValue();
			}

			return new JobDetails(
				jobId,
				jobName,
				startTime,
				endTime,
				duration,
				jobStatus,
				lastUpdateTime,
				numVerticesPerExecutionState,
				numTasks);
		}
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy