com.netflix.zuul.discovery

Class DiscoveryResult

java.lang.Object

com.netflix.zuul.discovery.DiscoveryResult

All Implemented Interfaces:

ResolverResult

public final class DiscoveryResult
extends java.lang.Object
implements ResolverResult

Since:

2/25/21

Wraps a single instance of discovery enabled server, and stats related to it.

Field Summary

Fields

Modifier and Type	Field and Description
static DiscoveryResult	EMPTY This exists to allow for a semblance of type safety, and encourages avoiding null checks on the underlying Server, thus representing a sentinel value for an empty resolution result.

Constructor Summary

Constructors

Constructor and Description
DiscoveryResult(com.netflix.niws.loadbalancer.DiscoveryEnabledServer server) This solely exists to create a result object from incomplete InstanceInfo.
DiscoveryResult(com.netflix.niws.loadbalancer.DiscoveryEnabledServer server, com.netflix.loadbalancer.LoadBalancerStats lbStats)

Method Summary

Modifier and Type	Method and Description
void	addToFailureCount()
void	clearSuccessiveConnectionFailureCount()
void	decrementActiveRequestsCount()
void	decrementOpenConnectionsCount()
boolean	equals(java.lang.Object obj) Two instances are deemed identical if they wrap the same underlying discovery server instance.
static DiscoveryResult	from(com.netflix.appinfo.InstanceInfo instanceInfo, boolean useSecurePort) This convenience method exists for usage in tests.
int	getActiveRequestsCount()
java.lang.String	getAppName()
java.lang.String	getASGName()
java.lang.String	getAvailabilityZone()
java.lang.String	getHost()
java.util.Optional<java.lang.String>	getIPAddr()
SimpleMetaInfo	getMetaInfo()
int	getOpenConnectionsCount()
int	getPort()
int	getSecurePort()
com.netflix.niws.loadbalancer.DiscoveryEnabledServer	getServer()
java.lang.String	getServerId()
java.lang.String	getTarget()
long	getTotalRequestsCount()
java.lang.String	getZone()
int	hashCode()
void	incrementActiveRequestsCount()
void	incrementNumRequests()
void	incrementOpenConnectionsCount()
void	incrementSuccessiveConnectionFailureCount()
boolean	isCircuitBreakerTripped()
boolean	isDiscoveryEnabled()
boolean	isSecurePortEnabled()
void	noteResponseTime(double msecs)
void	stopPublishingStats()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final DiscoveryResult EMPTY

This exists to allow for a semblance of type safety, and encourages avoiding null checks on the underlying Server, thus representing a sentinel value for an empty resolution result.

Constructor Detail

DiscoveryResult

public DiscoveryResult(com.netflix.niws.loadbalancer.DiscoveryEnabledServer server,
                       com.netflix.loadbalancer.LoadBalancerStats lbStats)

DiscoveryResult

public DiscoveryResult(com.netflix.niws.loadbalancer.DiscoveryEnabledServer server)

This solely exists to create a result object from incomplete InstanceInfo. Usage of this for production code is strongly discouraged, since the underlying instances are prone to memory leaks

Method Detail

from

public static DiscoveryResult from(com.netflix.appinfo.InstanceInfo instanceInfo,
                                   boolean useSecurePort)

This convenience method exists for usage in tests. For production usage, please use the constructor linked:

See Also:

DiscoveryResult(DiscoveryEnabledServer, LoadBalancerStats)

getIPAddr

public java.util.Optional<java.lang.String> getIPAddr()

getHost

public java.lang.String getHost()

Specified by:

getHost in interface ResolverResult

isDiscoveryEnabled

public boolean isDiscoveryEnabled()

Specified by:

isDiscoveryEnabled in interface ResolverResult

getPort

public int getPort()

Specified by:

getPort in interface ResolverResult

getSecurePort

public int getSecurePort()

isSecurePortEnabled

public boolean isSecurePortEnabled()

getTarget

public java.lang.String getTarget()

getMetaInfo

public SimpleMetaInfo getMetaInfo()

getAvailabilityZone

@Nullable
public java.lang.String getAvailabilityZone()

getZone

public java.lang.String getZone()

getServerId

public java.lang.String getServerId()

getServer

public com.netflix.niws.loadbalancer.DiscoveryEnabledServer getServer()

getASGName

public java.lang.String getASGName()

getAppName

public java.lang.String getAppName()

noteResponseTime

public void noteResponseTime(double msecs)

isCircuitBreakerTripped

public boolean isCircuitBreakerTripped()

incrementActiveRequestsCount

public void incrementActiveRequestsCount()

incrementOpenConnectionsCount

public void incrementOpenConnectionsCount()

incrementSuccessiveConnectionFailureCount

public void incrementSuccessiveConnectionFailureCount()

incrementNumRequests

public void incrementNumRequests()

getOpenConnectionsCount

public int getOpenConnectionsCount()

getTotalRequestsCount

public long getTotalRequestsCount()

getActiveRequestsCount

public int getActiveRequestsCount()

decrementOpenConnectionsCount

public void decrementOpenConnectionsCount()

decrementActiveRequestsCount

public void decrementActiveRequestsCount()

clearSuccessiveConnectionFailureCount

public void clearSuccessiveConnectionFailureCount()

addToFailureCount

public void addToFailureCount()

stopPublishingStats

public void stopPublishingStats()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Two instances are deemed identical if they wrap the same underlying discovery server instance.

Overrides:

equals in class java.lang.Object