org.apache.tez.runtime.api.events.InputFailedEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tez-api Show documentation
There is a newer version: 0.10.4
/**
 * 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.runtime.api.events;

import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.tez.runtime.api.Event;

/**
 * Event sent from the AM to an Input to indicate that one of it's sources has
 * failed - effectively the input is no longer available from the particular
 * source.
 * Users are not expected to send this event.
 */
@Private
public class InputFailedEvent extends Event{

  /**
   * Index(i) of the i-th (physical) Input or Output that is meant to receive
   * this Event. For a Processor event, this is ignored.
   */
  private int targetIndex;

  /**
   * Version number to indicate what attempt generated this Event
   */
  private int version;
  
  @Private // for Writable
  public InputFailedEvent() {
  }
  
  @Private
  private InputFailedEvent(int targetIndex, int version) {
    this.targetIndex = targetIndex;
    this.version = version;
  }

  @Private
  public static InputFailedEvent create(int targetIndex, int version) {
    return new InputFailedEvent(targetIndex, version);
  }
  
  /**
   * Create a copy of the {@link InputFailedEvent} by adding a target input
   * index The index of the physical input to which this event should be routed
   * 
   * @param targetIndex
   *          The index of the physical input to which this
   *          {@link InputFailedEvent} should be routed
   * 
   * @return copy of the {@link InputFailedEvent} with the target input index
   *         added
   */
  @Private
  public InputFailedEvent makeCopy(int targetIndex) {
    return create(targetIndex, version);
  }

  public int getTargetIndex() {
    return targetIndex;
  }

  @Private
  public void setTargetIndex(int targetIndex) {
    this.targetIndex = targetIndex;
  }

  public int getVersion() {
    return version;
  }

  @Private
  public void setVersion(int version) {
    this.version = version;
  }
}