org.apache.hadoop.yarn.api.records.LocalResourceVisibility 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;
/**
* LocalResourceVisibility specifies the visibility
* of a resource localized by the NodeManager.
*
* The visibility can be one of:
*
* - {@link #PUBLIC} - Shared by all users on the node.
* -
* {@link #PRIVATE} - Shared among all applications of the
* same user on the node.
*
* -
* {@link #APPLICATION} - Shared only among containers of the
* same application on the node.
*
*
*
*
* @see LocalResource
* @see ContainerLaunchContext
* @see ApplicationSubmissionContext
* @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
*/
@Public
@Stable
public enum LocalResourceVisibility {
/**
* Shared by all users on the node.
*/
PUBLIC,
/**
* Shared among all applications of the same user on the node.
*/
PRIVATE,
/**
* Shared only among containers of the same application on the node.
*/
APPLICATION
}