Package co.elastic.clients.elasticsearch.text_structure

Class TestGrokPatternRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.text_structure.TestGrokPatternRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class TestGrokPatternRequest
extends RequestBase
implements JsonpSerializable

Tests a Grok pattern on some text.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<TestGrokPatternRequest>	_DESERIALIZER	Json deserializer for TestGrokPatternRequest
static final Endpoint<TestGrokPatternRequest,TestGrokPatternResponse,ErrorResponse>	_ENDPOINT	Endpoint "text_structure.test_grok_pattern".

Method Summary

Modifier and Type	Method	Description
final String	ecsCompatibility()	The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled).
final String	grokPattern()	Required - Grok pattern to run on the text.
static TestGrokPatternRequest	of(Function<TestGrokPatternRequest.Builder,ObjectBuilder<TestGrokPatternRequest>> fn)
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	setupTestGrokPatternRequestDeserializer(ObjectDeserializer<TestGrokPatternRequest.Builder> op)
final List<String>	text()	Required - Lines of text to run the Grok pattern on.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TestGrokPatternRequest> _DESERIALIZER

Json deserializer for TestGrokPatternRequest

_ENDPOINT

public static final Endpoint<TestGrokPatternRequest,TestGrokPatternResponse,ErrorResponse> _ENDPOINT

Endpoint "text_structure.test_grok_pattern".

Method Details

of

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

ecsCompatibility

@Nullable
public final String ecsCompatibility()

The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled).

API name: ecs_compatibility

grokPattern

public final String grokPattern()

Required - Grok pattern to run on the text.

API name: grok_pattern

text

public final List<String> text()

Required - Lines of text to run the Grok pattern on.

API name: text

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)

setupTestGrokPatternRequestDeserializer

protected static void setupTestGrokPatternRequestDeserializer(ObjectDeserializer<TestGrokPatternRequest.Builder> op)