public class

LiveInstance

extends HelixProperty
java.lang.Object
   ↳ org.apache.helix.HelixProperty
     ↳ org.apache.helix.model.LiveInstance

Class Overview

Instance that connects to zookeeper (stored ephemerally)

Summary

Nested Classes
enum LiveInstance.LiveInstanceProperty Saved properties of a live instance  
[Expand]
Inherited Fields
From class org.apache.helix.HelixProperty
Public Constructors
LiveInstance(String id)
Instantiate with an instance identifier
LiveInstance(ParticipantId id)
Instantiate with an participant identifier
LiveInstance(ZNRecord record)
Instantiate with a pre-populated record
Public Methods
String getHelixVersion()
Get the version of Helix that this participant is running
String getInstanceName()
Get the name of this instance
String getLiveInstance()
Get an identifier that represents the instance and where it is located
long getModifiedTime()
Get the last modified time of this live instance
ParticipantId getParticipantId()
Get the id of this participant
ProcId getProcessId()
Get an identifier that represents the instance and where it is located
String getSessionId()
Get the session that this participant corresponds to
HelixVersion getTypedHelixVersion()
Get the version of Helix that this participant is running
SessionId getTypedSessionId()
Get the session that this participant corresponds to
String getWebserviceUrl()
Get a web service URL where ZK properties can be transferred to
boolean isValid()
Get property validity
void setHelixVersion(String helixVersion)
Set the version of Helix that this instance is running
void setLiveInstance(String liveInstance)
Set an identifier that represents the process
void setSessionId(String sessionId)
Set the session that this instance corresponds to
void setWebserviceUrl(String url)
Set a web service URL where ZK properties can be transferred to
[Expand]
Inherited Methods
From class org.apache.helix.HelixProperty
From class java.lang.Object

Public Constructors

public LiveInstance (String id)

Instantiate with an instance identifier

Parameters
id instance identifier

public LiveInstance (ParticipantId id)

Instantiate with an participant identifier

Parameters
id participant identifier

public LiveInstance (ZNRecord record)

Instantiate with a pre-populated record

Parameters
record ZNRecord corresponding to a live instance

Public Methods

public String getHelixVersion ()

Get the version of Helix that this participant is running

Returns
  • the version

public String getInstanceName ()

Get the name of this instance

Returns
  • the instance name

public String getLiveInstance ()

Get an identifier that represents the instance and where it is located

Returns
  • identifier, e.g. process_id@host

public long getModifiedTime ()

Get the last modified time of this live instance

Returns
  • UNIX timestamp

public ParticipantId getParticipantId ()

Get the id of this participant

Returns
  • participant id

public ProcId getProcessId ()

Get an identifier that represents the instance and where it is located

Returns
  • process identifier

public String getSessionId ()

Get the session that this participant corresponds to

Returns
  • session identifier

public HelixVersion getTypedHelixVersion ()

Get the version of Helix that this participant is running

Returns
  • the version

public SessionId getTypedSessionId ()

Get the session that this participant corresponds to

Returns
  • session identifier

public String getWebserviceUrl ()

Get a web service URL where ZK properties can be transferred to

Returns
  • a fully-qualified URL

public boolean isValid ()

Get property validity

Returns
  • true if valid, false if invalid

public void setHelixVersion (String helixVersion)

Set the version of Helix that this instance is running

Parameters
helixVersion the version

public void setLiveInstance (String liveInstance)

Set an identifier that represents the process

Parameters
liveInstance process identifier, e.g. process_id@host

public void setSessionId (String sessionId)

Set the session that this instance corresponds to

Parameters
sessionId session identifier

public void setWebserviceUrl (String url)

Set a web service URL where ZK properties can be transferred to

Parameters
url a fully-qualified URL