com.yahoo.prelude

Class Pong

java.lang.Object

com.yahoo.prelude.Pong

public class Pong
extends Object

An answer from Ping.

Author:

Steinar Knutsen

Field Summary

Fields

Modifier and Type	Field and Description
private ElapsedTime	elapsed
private List<ErrorMessage>	errors
private String	pingInfo
private Optional<PongPacket>	pongPacket

Constructor Summary

Constructors

Constructor and Description
Pong()
Pong(ErrorMessage error)
Pong(PongPacket pongPacket)

Method Summary

Modifier and Type	Method and Description
Optional<Long>	activeDocuments() Returns the number of active documents in the backend responding in this Pong, if available
Optional<Integer>	activeNodes() Returns the number of nodes which responded to this Pong, if available
void	addError(ErrorMessage error)
boolean	badResponse() Returns whether there is an error or not
ElapsedTime	getElapsedTime()
ErrorMessage	getError(int i)
List<ErrorMessage>	getErrors()
int	getErrorSize()
String	getPingInfo() Returns information about the ping use, or "" (never null) if none
Optional<PongPacket>	getPongPacket() Deprecated. do not use
void	setPingInfo(String pingInfo) Sets information about the ping used to produce this.
String	toString() Returns a string which included the ping info (if any) and any errors added to this

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pingInfo

private String pingInfo

errors

private final List<ErrorMessage> errors

pongPacket

private final Optional<PongPacket> pongPacket

elapsed

private ElapsedTime elapsed

Constructor Detail

Pong

public Pong()

Pong

public Pong(ErrorMessage error)

Pong

public Pong(PongPacket pongPacket)

Method Detail

addError

public void addError(ErrorMessage error)

getError

public ErrorMessage getError(int i)

getErrorSize

public int getErrorSize()

getPongPacket

@Deprecated
public Optional<PongPacket> getPongPacket()

Deprecated. do not use

Returns the package causing this to exist, or empty if none

activeDocuments

public Optional<Long> activeDocuments()

Returns the number of active documents in the backend responding in this Pong, if available

activeNodes

public Optional<Integer> activeNodes()

Returns the number of nodes which responded to this Pong, if available

getErrors

public List<ErrorMessage> getErrors()

badResponse

public boolean badResponse()

Returns whether there is an error or not

setPingInfo

public void setPingInfo(String pingInfo)

Sets information about the ping used to produce this. This is included when returning the tostring of this.

getPingInfo

public String getPingInfo()

Returns information about the ping use, or "" (never null) if none

getElapsedTime

public ElapsedTime getElapsedTime()

toString

public String toString()

Returns a string which included the ping info (if any) and any errors added to this

Overrides:

toString in class Object