YARN-8768. Javadoc error in node attributes. Contributed by Sunil Govindan.
This commit is contained in:
parent
02b9bfdf9e
commit
8e9afbfb66
|
@ -56,7 +56,7 @@ public abstract class GetAttributesToNodesRequest {
|
||||||
* Set node attributeKeys for which the mapping of hostname to attribute value
|
* Set node attributeKeys for which the mapping of hostname to attribute value
|
||||||
* is required.
|
* is required.
|
||||||
*
|
*
|
||||||
* @param attributes Set<NodeAttributeKey> provided.
|
* @param attributes Set of NodeAttributeKey provided.
|
||||||
*/
|
*/
|
||||||
@Public
|
@Public
|
||||||
@Unstable
|
@Unstable
|
||||||
|
@ -66,7 +66,7 @@ public abstract class GetAttributesToNodesRequest {
|
||||||
* Get node attributeKeys for which mapping of hostname to attribute value is
|
* Get node attributeKeys for which mapping of hostname to attribute value is
|
||||||
* required.
|
* required.
|
||||||
*
|
*
|
||||||
* @return Set<NodeAttributeKey>
|
* @return Set of NodeAttributeKey
|
||||||
*/
|
*/
|
||||||
@Public
|
@Public
|
||||||
@Unstable
|
@Unstable
|
||||||
|
|
|
@ -56,8 +56,7 @@ public abstract class GetAttributesToNodesResponse {
|
||||||
* Get mapping of NodeAttributeKey to its associated mapping of list of
|
* Get mapping of NodeAttributeKey to its associated mapping of list of
|
||||||
* NodeToAttributeValue associated with attribute.
|
* NodeToAttributeValue associated with attribute.
|
||||||
*
|
*
|
||||||
* @return Map<NodeAttributeKey, List<NodeToAttributeValue>> node attributes
|
* @return Map of node attributes to list of NodeToAttributeValue.
|
||||||
* to list of NodeToAttributeValuenode.
|
|
||||||
*/
|
*/
|
||||||
@Public
|
@Public
|
||||||
@Evolving
|
@Evolving
|
||||||
|
|
|
@ -57,7 +57,7 @@ public abstract class GetNodesToAttributesRequest {
|
||||||
/**
|
/**
|
||||||
* Get hostnames for which mapping is required.
|
* Get hostnames for which mapping is required.
|
||||||
*
|
*
|
||||||
* @return Set<String> of hostnames.
|
* @return Set of hostnames.
|
||||||
*/
|
*/
|
||||||
@InterfaceAudience.Public
|
@InterfaceAudience.Public
|
||||||
@InterfaceStability.Evolving
|
@InterfaceStability.Evolving
|
||||||
|
|
|
@ -55,7 +55,7 @@ public abstract class GetNodesToAttributesResponse {
|
||||||
/**
|
/**
|
||||||
* Get hostnames to NodeAttributes mapping.
|
* Get hostnames to NodeAttributes mapping.
|
||||||
*
|
*
|
||||||
* @return Map<String, Set<NodeAttribute>> host to attributes.
|
* @return Map of host to attributes.
|
||||||
*/
|
*/
|
||||||
@Public
|
@Public
|
||||||
@Evolving
|
@Evolving
|
||||||
|
|
|
@ -103,7 +103,7 @@ public abstract class NodeAttributesManager extends AbstractService {
|
||||||
/**
|
/**
|
||||||
* NodeAttribute to AttributeValue Map.
|
* NodeAttribute to AttributeValue Map.
|
||||||
*
|
*
|
||||||
* @return Map<NodeAttribute, AttributeValue> mapping of Attribute to Value.
|
* @return Map of NodeAttribute to AttributeValue.
|
||||||
*/
|
*/
|
||||||
public abstract Map<NodeAttribute, AttributeValue> getAttributesForNode(
|
public abstract Map<NodeAttribute, AttributeValue> getAttributesForNode(
|
||||||
String hostName);
|
String hostName);
|
||||||
|
@ -111,7 +111,7 @@ public abstract class NodeAttributesManager extends AbstractService {
|
||||||
/**
|
/**
|
||||||
* Get All node to Attributes list based on filter.
|
* Get All node to Attributes list based on filter.
|
||||||
*
|
*
|
||||||
* @return List<NodeToAttributes> nodeToAttributes matching filter.If empty
|
* @return List of NodeToAttributes matching filter. If empty
|
||||||
* or null is passed as argument will return all.
|
* or null is passed as argument will return all.
|
||||||
*/
|
*/
|
||||||
public abstract List<NodeToAttributes> getNodeToAttributes(
|
public abstract List<NodeToAttributes> getNodeToAttributes(
|
||||||
|
@ -120,8 +120,8 @@ public abstract class NodeAttributesManager extends AbstractService {
|
||||||
/**
|
/**
|
||||||
* Get all node to Attributes mapping.
|
* Get all node to Attributes mapping.
|
||||||
*
|
*
|
||||||
* @return Map<String, Set<NodeAttribute>> nodesToAttributes matching
|
* @return Map of String to Set of nodesToAttributes matching
|
||||||
* filter.If empty or null is passed as argument will return all.
|
* filter. If empty or null is passed as argument will return all.
|
||||||
*/
|
*/
|
||||||
public abstract Map<String, Set<NodeAttribute>> getNodesToAttributes(
|
public abstract Map<String, Set<NodeAttribute>> getNodesToAttributes(
|
||||||
Set<String> hostNames);
|
Set<String> hostNames);
|
||||||
|
|
|
@ -279,8 +279,7 @@ public class NodeAttributesManagerImpl extends NodeAttributesManager {
|
||||||
* @param nodeAttributeMapping
|
* @param nodeAttributeMapping
|
||||||
* @param newAttributesToBeAdded
|
* @param newAttributesToBeAdded
|
||||||
* @param isRemoveOperation : to indicate whether its a remove operation.
|
* @param isRemoveOperation : to indicate whether its a remove operation.
|
||||||
* @return Map<String, Map<NodeAttribute, AttributeValue>>, node -> Map(
|
* @return Map of String to Map of NodeAttribute to AttributeValue
|
||||||
* NodeAttribute -> AttributeValue)
|
|
||||||
* @throws IOException : on invalid mapping in the current request or against
|
* @throws IOException : on invalid mapping in the current request or against
|
||||||
* already existing NodeAttributes.
|
* already existing NodeAttributes.
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue