001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.hadoop.mapreduce;
020
021import org.apache.hadoop.classification.InterfaceAudience;
022import org.apache.hadoop.classification.InterfaceStability;
023import org.apache.hadoop.util.Progressable;
024
025/**
026 * The context for task attempts.
027 */
028@InterfaceAudience.Public
029@InterfaceStability.Evolving
030public interface TaskAttemptContext extends JobContext, Progressable {
031
032  /**
033   * Get the unique name for this task attempt.
034   */
035  public TaskAttemptID getTaskAttemptID();
036
037  /**
038   * Set the current status of the task to the given string.
039   */
040  public void setStatus(String msg);
041
042  /**
043   * Get the last set status message.
044   * @return the current status message
045   */
046  public String getStatus();
047  
048  /**
049   * The current progress of the task attempt.
050   * @return a number between 0.0 and 1.0 (inclusive) indicating the attempt's
051   * progress.
052   */
053  public abstract float getProgress();
054
055  /**
056   * Get the {@link Counter} for the given <code>counterName</code>.
057   * @param counterName counter name
058   * @return the <code>Counter</code> for the given <code>counterName</code>
059   */
060  public Counter getCounter(Enum<?> counterName);
061
062  /**
063   * Get the {@link Counter} for the given <code>groupName</code> and 
064   * <code>counterName</code>.
065   * @param counterName counter name
066   * @return the <code>Counter</code> for the given <code>groupName</code> and 
067   *         <code>counterName</code>
068   */
069  public Counter getCounter(String groupName, String counterName);
070
071}