Package org.apache.hadoop.yarn.nodelabels

Interface NodeLabelsStore

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

FileSystemNodeLabelsStore, NonAppendableFSNodeLabelStore

public interface NodeLabelsStore
extends java.io.Closeable

Interface class for Node label store.

Method Summary

Modifier and Type	Method	Description
void	init(org.apache.hadoop.conf.Configuration conf, CommonNodeLabelsManager mgr)
void	recover()	Recover labels and node to labels mappings from store, but if ignoreNodeToLabelsMappings is true then node to labels mappings should not be recovered.
void	removeClusterNodeLabels(java.util.Collection<java.lang.String> labels)	Remove labels.
void	storeNewClusterNodeLabels(java.util.List<org.apache.hadoop.yarn.api.records.NodeLabel> labels)	Store new labels.
void	updateNodeToLabelsMappings(java.util.Map<org.apache.hadoop.yarn.api.records.NodeId,java.util.Set<java.lang.String>> nodeToLabels)	Store node -> label.

Methods inherited from interface java.io.Closeable

close

Method Detail

updateNodeToLabelsMappings

void updateNodeToLabelsMappings(java.util.Map<org.apache.hadoop.yarn.api.records.NodeId,java.util.Set<java.lang.String>> nodeToLabels)
                         throws java.io.IOException

Store node -> label.

Parameters:

nodeToLabels - node to labels mapping.

Throws:

java.io.IOException - io error occur.

storeNewClusterNodeLabels

void storeNewClusterNodeLabels(java.util.List<org.apache.hadoop.yarn.api.records.NodeLabel> labels)
                        throws java.io.IOException

Store new labels.

Parameters:

labels - labels.

Throws:

java.io.IOException - io error occur.

removeClusterNodeLabels

void removeClusterNodeLabels(java.util.Collection<java.lang.String> labels)
                      throws java.io.IOException

Remove labels.

Parameters:

labels - labels.

Throws:

java.io.IOException - io error occur.

recover

void recover()
      throws java.io.IOException,
             org.apache.hadoop.yarn.exceptions.YarnException

Recover labels and node to labels mappings from store, but if ignoreNodeToLabelsMappings is true then node to labels mappings should not be recovered. In case of Distributed NodeLabels setup ignoreNodeToLabelsMappings will be set to true and recover will be invoked as RM will collect the node labels from NM through registration/HB.

Throws:

java.io.IOException - io error occur.

org.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.

init

void init(org.apache.hadoop.conf.Configuration conf,
          CommonNodeLabelsManager mgr)
   throws java.lang.Exception

Throws:

java.lang.Exception