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.yarn.api.records;
020
021import org.apache.hadoop.classification.InterfaceAudience.Public;
022import org.apache.hadoop.classification.InterfaceStability.Stable;
023import org.apache.hadoop.yarn.api.ContainerManager;
024
025/**
026 * <p><code>LocalResourceType</code> specifies the <em>type</em>
027 * of a resource localized by the <code>NodeManager</code>.</p> 
028 *
029 * <p>The <em>type</em> can be one of:
030 *   <ul>
031 *     <li>
032 *       {@link #FILE} - Regular file i.e. uninterpreted bytes. 
033 *     </li>
034 *     <li>
035 *       {@link #ARCHIVE} - Archive, which is automatically unarchived by the 
036 *       <code>NodeManager</code>.
037 *     </li>
038 *   </ul>
039 * </p>
040 *
041 * @see LocalResource
042 * @see ContainerLaunchContext
043 * @see ApplicationSubmissionContext
044 * @see ContainerManager#startContainer(org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest)
045 */
046@Public
047@Stable
048public enum LocalResourceType {
049  
050  /**
051   * Archive, which is automatically unarchived by the <code>NodeManager</code>.
052   */
053  ARCHIVE,
054  
055  /**
056   * Regular file i.e. uninterpreted bytes.
057   */
058  FILE,
059  
060  /**
061   * A hybrid between archive and file.  Only part of the file is unarchived,
062   * and the original file is left in place, but in the same directory as the
063   * unarchived part.  The part that is unarchived is determined by pattern
064   * in #{@link LocalResource}.  Currently only jars support pattern, all
065   * others will be treated like a #{@link LocalResourceType#ARCHIVE}.
066   */
067  PATTERN
068}