Package org.elasticsearch.xpack.esql.expression.promql.function

Record Class PromqlFunctionDefinition.StackAvailability

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.esql.expression.promql.function.PromqlFunctionDefinition.StackAvailability

Enclosing class:

PromqlFunctionDefinition

public static record PromqlFunctionDefinition.StackAvailability(FunctionAppliesToLifecycle lifecycle, PromqlFunctionDefinition.PromqlDocsVersion since)
extends Record

A single stack availability entry for a function's docs badge: a lifecycle state and the release it applies from, for example preview 9.4 or ga 9.5.

Constructor Summary

Constructors

Constructor	Description
StackAvailability(FunctionAppliesToLifecycle lifecycle, PromqlFunctionDefinition.PromqlDocsVersion since)	Creates an instance of a StackAvailability record class.

Method Summary

Modifier and Type	Method	Description
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.
FunctionAppliesToLifecycle	lifecycle()	Returns the value of the lifecycle record component.
PromqlFunctionDefinition.PromqlDocsVersion	since()	Returns the value of the since 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

StackAvailability

public StackAvailability(FunctionAppliesToLifecycle lifecycle,
 PromqlFunctionDefinition.PromqlDocsVersion since)

Creates an instance of a StackAvailability record class.

Parameters:

lifecycle - the value for the lifecycle record component

since - the value for the since record component

Method Details

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

lifecycle

public FunctionAppliesToLifecycle lifecycle()

Returns the value of the lifecycle record component.

Returns:

the value of the lifecycle record component

since

public PromqlFunctionDefinition.PromqlDocsVersion since()

Returns the value of the since record component.

Returns:

the value of the since record component