Package org.opensearch.client.opensearch._types

Class DerivedField

java.lang.Object

org.opensearch.client.opensearch._types.DerivedField

All Implemented Interfaces:

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

@JsonpDeserializable
public class DerivedField
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<DerivedField.Builder,DerivedField>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static DerivedField.Builder	builder()
boolean	equals(Object o)
final String	format()	API name: format
int	hashCode()
final Boolean	ignoreMalformed()	API name: ignore_malformed
final String	name()	Required - API name: name
static DerivedField	of(Function<DerivedField.Builder,ObjectBuilder<DerivedField>> fn)
final String	prefilterField()	API name: prefilter_field
final Map<String,JsonData>	properties()	API name: properties
final Script	script()	Required - API name: script
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	setupDerivedFieldDeserializer(ObjectDeserializer<DerivedField.Builder> op)
DerivedField.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	type()	Required - API name: type

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 Details

_DESERIALIZER

public static final JsonpDeserializer<DerivedField> _DESERIALIZER

Json deserializer for DerivedField

Method Details

of

public static DerivedField of(Function<DerivedField.Builder,ObjectBuilder<DerivedField>> fn)

format

@Nullable
public final String format()

API name: format

ignoreMalformed

@Nullable
public final Boolean ignoreMalformed()

API name: ignore_malformed

name

@Nonnull
public final String name()

Required - API name: name

prefilterField

@Nullable
public final String prefilterField()

API name: prefilter_field

properties

@Nonnull
public final Map<String,JsonData> properties()

API name: properties

script

@Nonnull
public final Script script()

Required - API name: script

type

@Nonnull
public final String type()

Required - API name: type

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 DerivedField.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<DerivedField.Builder,DerivedField>

Returns:

a new builder instance.

builder

@Nonnull
public static DerivedField.Builder builder()

setupDerivedFieldDeserializer

protected static void setupDerivedFieldDeserializer(ObjectDeserializer<DerivedField.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object