org.apache.hadoop.yarn.api.records.LocalResourceType Maven / Gradle / Ivy
/**
* 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.hadoop.yarn.api.records;
import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Stable;
import org.apache.hadoop.yarn.api.ContainerManagementProtocol;
/**
* LocalResourceType
specifies the type
* of a resource localized by the NodeManager
.
*
* The type can be one of:
*
* -
* {@link #FILE} - Regular file i.e. uninterpreted bytes.
*
* -
* {@link #ARCHIVE} - Archive, which is automatically unarchived by the
*
NodeManager
.
*
* -
* {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
*
*
*
* @see LocalResource
* @see ContainerLaunchContext
* @see ApplicationSubmissionContext
* @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
*/
@Public
@Stable
public enum LocalResourceType {
/**
* Archive, which is automatically unarchived by the NodeManager
.
*/
ARCHIVE,
/**
* Regular file i.e. uninterpreted bytes.
*/
FILE,
/**
* A hybrid between archive and file. Only part of the file is unarchived,
* and the original file is left in place, but in the same directory as the
* unarchived part. The part that is unarchived is determined by pattern
* in #{@link LocalResource}. Currently only jars support pattern, all
* others will be treated like a #{@link LocalResourceType#ARCHIVE}.
*/
PATTERN
}