Package google.registry.whois

Record Class WhoisMetrics.WhoisMetric

java.lang.Object

java.lang.Record

google.registry.whois.WhoisMetrics.WhoisMetric

Enclosing class:

WhoisMetrics

public static record WhoisMetrics.WhoisMetric(Optional<String> commandName, int numResults, int status, org.joda.time.DateTime startTimestamp, org.joda.time.DateTime endTimestamp)
extends Record

A value class for recording attributes of a WHOIS metric.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WhoisMetrics.WhoisMetric.Builder	A builder to create instances of WhoisMetrics.WhoisMetric.

Constructor Summary

Constructors

Constructor	Description
WhoisMetric(Optional<String> commandName, int numResults, int status, org.joda.time.DateTime startTimestamp, org.joda.time.DateTime endTimestamp)	Creates an instance of a WhoisMetric record class.

Method Summary

Modifier and Type	Method	Description
static WhoisMetrics.WhoisMetric.Builder	builder()	Create a WhoisMetrics.WhoisMetric.Builder.
static WhoisMetrics.WhoisMetric.Builder	builderForRequest(Clock clock)	Create a WhoisMetrics.WhoisMetric.Builder for a request context, with the start and end timestamps taken from the given clock.
Optional<String>	commandName()	Returns the value of the commandName record component.
org.joda.time.DateTime	endTimestamp()	Returns the value of the endTimestamp record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	numResults()	Returns the value of the numResults record component.
org.joda.time.DateTime	startTimestamp()	Returns the value of the startTimestamp record component.
int	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

WhoisMetric

public WhoisMetric(Optional<String> commandName,
 int numResults,
 int status,
 org.joda.time.DateTime startTimestamp,
 org.joda.time.DateTime endTimestamp)

Creates an instance of a WhoisMetric record class.

Parameters:

commandName - the value for the commandName record component

numResults - the value for the numResults record component

status - the value for the status record component

startTimestamp - the value for the startTimestamp record component

endTimestamp - the value for the endTimestamp record component

Method Details

builderForRequest

public static WhoisMetrics.WhoisMetric.Builder builderForRequest(Clock clock)

Create a WhoisMetrics.WhoisMetric.Builder for a request context, with the start and end timestamps taken from the given clock.

The start timestamp is recorded now, and the end timestamp at build().

builder

public static WhoisMetrics.WhoisMetric.Builder builder()

Create a WhoisMetrics.WhoisMetric.Builder.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

commandName

public Optional<String> commandName()

Returns the value of the commandName record component.

Returns:

the value of the commandName record component

numResults

public int numResults()

Returns the value of the numResults record component.

Returns:

the value of the numResults record component

status

public int status()

Returns the value of the status record component.

Returns:

the value of the status record component

startTimestamp

public org.joda.time.DateTime startTimestamp()

Returns the value of the startTimestamp record component.

Returns:

the value of the startTimestamp record component

endTimestamp

public org.joda.time.DateTime endTimestamp()

Returns the value of the endTimestamp record component.

Returns:

the value of the endTimestamp record component