Package org.opensearch.client.opensearch._types

Class PhaseTook

java.lang.Object

org.opensearch.client.opensearch._types.PhaseTook

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<PhaseTook.Builder,PhaseTook>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class PhaseTook
extends java.lang.Object
implements PlainJsonSerializable, ToCopyableBuilder<PhaseTook.Builder,PhaseTook>

The time taken by different phases of the search.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PhaseTook.Builder	Builder for PhaseTook.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PhaseTook>	_DESERIALIZER	Json deserializer for PhaseTook

Method Summary

Modifier and Type	Method	Description
static PhaseTook.Builder	builder()
int	canMatch()	Required - The time taken for the can_match phase.
int	dfsPreQuery()	Required - The time taken for the distributed frequency search pre-query phase.
int	dfsQuery()	Required - The time taken for the distributed frequency search query phase.
boolean	equals(java.lang.Object o)
int	expand()	Required - The time taken for the expand phase.
int	fetch()	Required - The time taken for the fetch phase.
int	hashCode()
static PhaseTook	of(java.util.function.Function<PhaseTook.Builder,ObjectBuilder<PhaseTook>> fn)
int	query()	Required - The time taken for the query phase.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPhaseTookDeserializer(ObjectDeserializer<PhaseTook.Builder> op)
PhaseTook.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<PhaseTook> _DESERIALIZER

Json deserializer for PhaseTook

Method Detail

of

public static PhaseTook of(java.util.function.Function<PhaseTook.Builder,ObjectBuilder<PhaseTook>> fn)

canMatch

public final int canMatch()

Required - The time taken for the can_match phase.

API name: can_match

dfsPreQuery

public final int dfsPreQuery()

Required - The time taken for the distributed frequency search pre-query phase.

API name: dfs_pre_query

dfsQuery

public final int dfsQuery()

Required - The time taken for the distributed frequency search query phase.

API name: dfs_query

expand

public final int expand()

Required - The time taken for the expand phase.

API name: expand

fetch

public final int fetch()

Required - The time taken for the fetch phase.

API name: fetch

query

public final int query()

Required - The time taken for the query phase.

API name: query

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

toBuilder

@Nonnull
public PhaseTook.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PhaseTook.Builder,PhaseTook>

Returns:

a new builder instance.

builder

@Nonnull
public static PhaseTook.Builder builder()

setupPhaseTookDeserializer

protected static void setupPhaseTookDeserializer(ObjectDeserializer<PhaseTook.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object