Package org.elasticsearch.xpack.esql.plan.physical

Class UserAgentExec

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<PhysicalPlan>

org.elasticsearch.xpack.esql.plan.QueryPlan<PhysicalPlan>

org.elasticsearch.xpack.esql.plan.physical.PhysicalPlan

org.elasticsearch.xpack.esql.plan.physical.UnaryExec

org.elasticsearch.xpack.esql.plan.physical.CompoundOutputEvalExec

org.elasticsearch.xpack.esql.plan.physical.UserAgentExec

All Implemented Interfaces:

NamedWriteable, Writeable, EstimatesRowSize

public class UserAgentExec
extends CompoundOutputEvalExec

Physical plan for the USER_AGENT command.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.plan.physical.EstimatesRowSize

EstimatesRowSize.State

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY

Fields inherited from class org.elasticsearch.xpack.esql.plan.physical.CompoundOutputEvalExec

input

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
UserAgentExec(StreamInput in)
UserAgentExec(Source source, PhysicalPlan child, Expression input, List<String> outputFieldNames, List<Attribute> outputFieldAttributes, boolean extractDeviceType, String regexFile)

Method Summary

Modifier and Type	Method	Description
CompoundOutputEvalExec	createNewInstance(Source source, PhysicalPlan child, Expression input, List<String> outputFieldNames, List<Attribute> outputFieldAttributes)	Creates a new instance of the specific CompoundOutputEvalExec subclass with the provided parameters.
boolean	extractDeviceType()
String	getWriteableName()
protected NodeInfo<? extends PhysicalPlan>	info()	Normally, you want to use one of the static create methods to implement this.
protected boolean	innerEquals(CompoundOutputEvalExec other)
protected int	innerHashCode()
String	regexFile()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.CompoundOutputEvalExec

computeReferences, equals, estimateRowSize, hashCode, input, output, outputFieldAttributes, outputFieldNames, replaceChild

Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.UnaryExec

child, inputSet, outputSet, replaceChildren

Methods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan

computeExpressions, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, references, transformExpressionsDown, transformExpressionsDown, transformExpressionsOnly, transformExpressionsOnly, transformExpressionsOnlyUp, transformExpressionsUp, transformExpressionsUp

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, nodeString, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, toString, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

UserAgentExec

public UserAgentExec(Source source,
 PhysicalPlan child,
 Expression input,
 List<String> outputFieldNames,
 List<Attribute> outputFieldAttributes,
 boolean extractDeviceType,
 String regexFile)

UserAgentExec

public UserAgentExec(StreamInput in)
              throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class CompoundOutputEvalExec

Throws:

IOException

getWriteableName

public String getWriteableName()

info

protected NodeInfo<? extends PhysicalPlan> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Overrides:

info in class CompoundOutputEvalExec

createNewInstance

public CompoundOutputEvalExec createNewInstance(Source source,
 PhysicalPlan child,
 Expression input,
 List<String> outputFieldNames,
 List<Attribute> outputFieldAttributes)

Description copied from class: CompoundOutputEvalExec

Creates a new instance of the specific CompoundOutputEvalExec subclass with the provided parameters.

Specified by:

createNewInstance in class CompoundOutputEvalExec

innerEquals

protected boolean innerEquals(CompoundOutputEvalExec other)

Specified by:

innerEquals in class CompoundOutputEvalExec

innerHashCode

protected int innerHashCode()

Specified by:

innerHashCode in class CompoundOutputEvalExec

extractDeviceType

public boolean extractDeviceType()

regexFile

public String regexFile()