Package com.yahoo.config.provision

Class HostSpec

  • All Implemented Interfaces:
    java.lang.Comparable<HostSpec>
    public class HostSpec
extends java.lang.Object
implements java.lang.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​(java.lang.String hostname, ClusterMembership membership, Flavor flavor, java.util.Optional<com.yahoo.component.Version> version)
      Deprecated.
      HostSpec​(java.lang.String hostname, NodeResources realResources, NodeResources advertisedResources, NodeResources requestedResources, ClusterMembership membership, java.util.Optional<com.yahoo.component.Version> version, java.util.Optional<NetworkPorts> networkPorts, java.util.Optional<DockerImage> dockerImageRepo)
      Create a host in a hosted system
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases)
      Deprecated.
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases, ClusterMembership membership)
      Deprecated.
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases, Flavor flavor)
      Deprecated.
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases, java.util.Optional<Flavor> flavor, java.util.Optional<ClusterMembership> membership)
      Deprecated.
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases, java.util.Optional<Flavor> flavor, java.util.Optional<ClusterMembership> membership, java.util.Optional<com.yahoo.component.Version> version)
      Deprecated.
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases, java.util.Optional<Flavor> flavor, java.util.Optional<ClusterMembership> membership, java.util.Optional<com.yahoo.component.Version> version, java.util.Optional<NetworkPorts> networkPorts)
      Deprecated.
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases, java.util.Optional<Flavor> flavor, java.util.Optional<ClusterMembership> membership, java.util.Optional<com.yahoo.component.Version> version, java.util.Optional<NetworkPorts> networkPorts, java.util.Optional<NodeResources> requestedResources)
      Deprecated.
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases, java.util.Optional<Flavor> flavor, java.util.Optional<ClusterMembership> membership, java.util.Optional<com.yahoo.component.Version> version, java.util.Optional<NetworkPorts> networkPorts, java.util.Optional<NodeResources> requestedResources, java.util.Optional<DockerImage> dockerImageRepo)
      Deprecated.
      HostSpec​(java.lang.String hostname, java.util.List<java.lang.String> aliases, java.util.Optional<NetworkPorts> networkPorts)
      Create a host in a non-cloud system, where hosts are specified in config
      HostSpec​(java.lang.String hostname, java.util.Optional<ClusterMembership> membership)
      Deprecated.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      NodeResources advertisedResources()
      The total advertised resources of this node, typically matching what's requested.
      java.util.List<java.lang.String> aliases()
      Returns the aliases of this host as an immutable list.
      int compareTo​(HostSpec other)  
      java.util.Optional<DockerImage> dockerImageRepo()  
      boolean equals​(java.lang.Object other)  
      java.util.Optional<Flavor> flavor()
      A flavor contained the advertised resources of this host
      int hashCode()  
      java.lang.String hostname()
      Returns the name identifying this host
      java.util.Optional<ClusterMembership> membership()
      Returns the membership of this host, or an empty value if not present
      java.util.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.
      java.util.Optional<NodeResources> requestedResources()
      Returns the requested resources leading to this host being provisioned, or empty if unspecified
      java.lang.String toString()  
      java.util.Optional<com.yahoo.component.Version> version()
      Returns the current version of Vespa running on this node, or empty if not known
      HostSpec withPorts​(java.util.Optional<NetworkPorts> ports)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HostSpec

        public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases,
                java.util.Optional<NetworkPorts> networkPorts)
        Create a host in a non-cloud system, where hosts are specified in config

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.Optional<ClusterMembership> membership)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                ClusterMembership membership,
                Flavor flavor,
                java.util.Optional<com.yahoo.component.Version> version)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases,
                Flavor flavor)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases,
                ClusterMembership membership)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases,
                java.util.Optional<Flavor> flavor,
                java.util.Optional<ClusterMembership> membership)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases,
                java.util.Optional<Flavor> flavor,
                java.util.Optional<ClusterMembership> membership,
                java.util.Optional<com.yahoo.component.Version> version)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases,
                java.util.Optional<Flavor> flavor,
                java.util.Optional<ClusterMembership> membership,
                java.util.Optional<com.yahoo.component.Version> version,
                java.util.Optional<NetworkPorts> networkPorts)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases,
                java.util.Optional<Flavor> flavor,
                java.util.Optional<ClusterMembership> membership,
                java.util.Optional<com.yahoo.component.Version> version,
                java.util.Optional<NetworkPorts> networkPorts,
                java.util.Optional<NodeResources> requestedResources)
        Deprecated.

      • HostSpec

        @Deprecated
public HostSpec​(java.lang.String hostname,
                java.util.List<java.lang.String> aliases,
                java.util.Optional<Flavor> flavor,
                java.util.Optional<ClusterMembership> membership,
                java.util.Optional<com.yahoo.component.Version> version,
                java.util.Optional<NetworkPorts> networkPorts,
                java.util.Optional<NodeResources> requestedResources,
                java.util.Optional<DockerImage> dockerImageRepo)
        Deprecated.

    • Method Detail

      • hostname

        public java.lang.String hostname()
        Returns the name identifying this host

      • aliases

        public java.util.List<java.lang.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.

      • flavor

        public java.util.Optional<Flavor> flavor()
        A flavor contained the advertised resources of this host

      • version

        public java.util.Optional<com.yahoo.component.Version> version()
        Returns the current version of Vespa running on this node, or empty if not known

      • membership

        public java.util.Optional<ClusterMembership> membership()
        Returns the membership of this host, or an empty value if not present

      • networkPorts

        public java.util.Optional<NetworkPorts> networkPorts()
        Returns the network port allocations on this host, or empty if not present

      • requestedResources

        public java.util.Optional<NodeResources> requestedResources()
        Returns the requested resources leading to this host being provisioned, or empty if unspecified

      • dockerImageRepo

        public java.util.Optional<DockerImage> dockerImageRepo()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • compareTo

        public int compareTo​(HostSpec other)
        Specified by:
        compareTo in interface java.lang.Comparable<HostSpec>