Package com.yahoo.config.provision

Class HostSpec

java.lang.Object

com.yahoo.config.provision.HostSpec

All Implemented Interfaces:

Comparable<HostSpec>

public class HostSpec
extends Object
implements Comparable<HostSpec>

A specification of a host and its role. Equality and order is determined by the host name.

Author:

hmusum

Constructor Summary

Constructors

Constructor	Description
HostSpec(String hostname, NodeResources realResources, NodeResources advertisedResources, NodeResources requestedResources, ClusterMembership membership, Optional<com.yahoo.component.Version> version, Optional<NetworkPorts> networkPorts, Optional<DockerImage> dockerImageRepo)	Create a host in a hosted system
HostSpec(String hostname, List<String> aliases, Optional<NetworkPorts> networkPorts)	Create a host in a non-cloud system, where hosts are specified in config

Method Summary

Modifier and Type	Method	Description
NodeResources	advertisedResources()	The total advertised resources of this node, typically matching what's requested.
List<String>	aliases()	Returns the aliases of this host as an immutable list.
int	compareTo(HostSpec other)
Optional<DockerImage>	dockerImageRepo()
boolean	equals(Object other)
int	hashCode()
String	hostname()	Returns the name identifying this host
Optional<ClusterMembership>	membership()	Returns the membership of this host, or an empty value if not present
Optional<NetworkPorts>	networkPorts()	Returns the network port allocations on this host, or empty if not present
NodeResources	realResources()	The real resources available for Vespa processes on this node, after subtracting infrastructure overhead.
Optional<NodeResources>	requestedResources()	Returns the requested resources leading to this host being provisioned, or empty if unspecified
String	toString()
Optional<com.yahoo.component.Version>	version()	Returns the current version of Vespa running on this node, or empty if not known
HostSpec	withPorts(Optional<NetworkPorts> ports)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HostSpec

public HostSpec(String hostname,
                List<String> aliases,
                Optional<NetworkPorts> networkPorts)

Create a host in a non-cloud system, where hosts are specified in config

HostSpec

public HostSpec(String hostname,
                NodeResources realResources,
                NodeResources advertisedResources,
                NodeResources requestedResources,
                ClusterMembership membership,
                Optional<com.yahoo.component.Version> version,
                Optional<NetworkPorts> networkPorts,
                Optional<DockerImage> dockerImageRepo)

Create a host in a hosted system

Method Detail

hostname

public String hostname()

Returns the name identifying this host

aliases

public List<String> aliases()

Returns the aliases of this host as an immutable list. This may be empty but never null.

realResources

public NodeResources realResources()

The real resources available for Vespa processes on this node, after subtracting infrastructure overhead.

advertisedResources

public NodeResources advertisedResources()

The total advertised resources of this node, typically matching what's requested.

version

public Optional<com.yahoo.component.Version> version()

Returns the current version of Vespa running on this node, or empty if not known

membership

public Optional<ClusterMembership> membership()

Returns the membership of this host, or an empty value if not present

networkPorts

public Optional<NetworkPorts> networkPorts()

Returns the network port allocations on this host, or empty if not present

requestedResources

public Optional<NodeResources> requestedResources()

Returns the requested resources leading to this host being provisioned, or empty if unspecified

dockerImageRepo

public Optional<DockerImage> dockerImageRepo()

withPorts

public HostSpec withPorts(Optional<NetworkPorts> ports)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(HostSpec other)

Specified by:

compareTo in interface Comparable<HostSpec>