tez-dag/src/main/java/org/apache/tez/dag/history/SummaryEvent.java

/**
 * 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.tez.dag.history;

import java.io.IOException;
import java.io.OutputStream;

import org.apache.tez.dag.recovery.records.RecoveryProtos.SummaryEventProto;

public interface SummaryEvent {

  public void toSummaryProtoStream(OutputStream outputStream) throws IOException;

  public void fromSummaryProtoStream(SummaryEventProto proto) throws IOException;

  /**
   * Whether to write this event immediately to the DAG recovery file
   * Summary events are always written immediately to summary file.
   * @return true if event should be written immediately to the DAG recovery file
   */
  public boolean writeToRecoveryImmediately();

}