Package com.yahoo.config.provision

Class ClusterMembership

java.lang.Object

com.yahoo.config.provision.ClusterMembership

public class ClusterMembership
extends Object

A node's membership in a cluster. This is a value object. The format is "clusterType/clusterId/groupId/index[/exclusive][/retired][/stateful][/combinedId]"

Author:

bratseth

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClusterMembership()

Method Summary

Modifier and Type	Method	Description
ClusterSpec	cluster()	Returns the cluster this node is a member of
boolean	equals(Object o)
static ClusterMembership	from(ClusterSpec cluster, int index)
static ClusterMembership	from(String stringValue, com.yahoo.component.Version vespaVersion, Optional<DockerImage> dockerImageRepo)
int	hashCode()
int	index()	Returns the index of this node within the cluster
ClusterMembership	retire()	Returns a copy of this which is retired
boolean	retired()	Returns whether the cluster should prepare for this node to be removed
static ClusterMembership	retiredFrom(ClusterSpec cluster, int index)
String	stringValue()	Returns all the information in this as a string which can be used to construct the same ClusterMembership instance using from(java.lang.String, com.yahoo.component.Version, java.util.Optional<com.yahoo.config.provision.DockerImage>).
String	toString()
protected String	toStringValue()
ClusterMembership	unretire()	Returns a copy of this node which is not retired
ClusterMembership	with(ClusterSpec newCluster)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterMembership

protected ClusterMembership()

Method Detail

toStringValue

protected String toStringValue()

cluster

public ClusterSpec cluster()

Returns the cluster this node is a member of

index

public int index()

Returns the index of this node within the cluster

retired

public boolean retired()

Returns whether the cluster should prepare for this node to be removed

retire

public ClusterMembership retire()

Returns a copy of this which is retired

unretire

public ClusterMembership unretire()

Returns a copy of this node which is not retired

with

public ClusterMembership with(ClusterSpec newCluster)

stringValue

public String stringValue()

Returns all the information in this as a string which can be used to construct the same ClusterMembership instance using from(java.lang.String, com.yahoo.component.Version, java.util.Optional<com.yahoo.config.provision.DockerImage>). This string is currently stored in ZooKeeper on running instances.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static ClusterMembership from(String stringValue,
                                     com.yahoo.component.Version vespaVersion,
                                     Optional<DockerImage> dockerImageRepo)

from

public static ClusterMembership from(ClusterSpec cluster,
                                     int index)

retiredFrom

public static ClusterMembership retiredFrom(ClusterSpec cluster,
                                            int index)