Package com.yahoo.config.provision

Enum NodeType

java.lang.Object

java.lang.Enum<NodeType>

com.yahoo.config.provision.NodeType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NodeType>

public enum NodeType
extends java.lang.Enum<NodeType>

The possible types of nodes in the node repository

Author:

bratseth

Enum Constant Summary

Enum Constants

Enum Constant	Description
config	A config server
confighost	A host of a (Docker) config server node
controller	A controller
controllerhost	A host of a (Docker) controller node
devhost	A host of multiple nodes, only used in SystemName.dev
host	A host of a set of (Docker) tenant nodes
proxy	Nodes running the shared proxy layer
proxyhost	A host of a (Docker) proxy node
tenant	A node to be assigned to a tenant to run application workloads

Method Summary

Modifier and Type	Method	Description
boolean	canRun(NodeType type)
NodeType	childNodeType()
java.util.List<NodeType>	childNodeTypes()
java.lang.String	description()
boolean	isDockerHost()	Deprecated.
boolean	isHost()
static NodeType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static NodeType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

tenant

public static final NodeType tenant

A node to be assigned to a tenant to run application workloads

host

public static final NodeType host

A host of a set of (Docker) tenant nodes

proxy

public static final NodeType proxy

Nodes running the shared proxy layer

proxyhost

public static final NodeType proxyhost

A host of a (Docker) proxy node

config

public static final NodeType config

A config server

confighost

public static final NodeType confighost

A host of a (Docker) config server node

controller

public static final NodeType controller

A controller

controllerhost

public static final NodeType controllerhost

A host of a (Docker) controller node

devhost

public static final NodeType devhost

A host of multiple nodes, only used in SystemName.dev

Method Detail

values

public static NodeType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NodeType c : NodeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NodeType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isDockerHost

@Deprecated
public boolean isDockerHost()

Deprecated.

isHost

public boolean isHost()

description

public java.lang.String description()

childNodeType

public NodeType childNodeType()

Returns:

NodeType of the node(s) that run on this host

Throws:

java.lang.IllegalStateException - if this type is not a host

childNodeTypes

public java.util.List<NodeType> childNodeTypes()

Returns:

all NodeTypes that can run on this host

Throws:

java.lang.IllegalStateException - if this type is not a host

canRun

public boolean canRun(NodeType type)

Parameters:

type - Child NodeType

Returns:

true if the NodeType can run on this host, false otherwise.