Package co.elastic.clients.elasticsearch.text_structure

Class ElasticsearchTextStructureAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchTextStructureAsyncClient>

co.elastic.clients.elasticsearch.text_structure.ElasticsearchTextStructureAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchTextStructureAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchTextStructureAsyncClient>

Client for the text_structure namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchTextStructureAsyncClient(ElasticsearchTransport transport)
ElasticsearchTextStructureAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<FindFieldStructureResponse>	findFieldStructure(FindFieldStructureRequest request)	Find the structure of a text field.
final CompletableFuture<FindFieldStructureResponse>	findFieldStructure(Function<FindFieldStructureRequest.Builder,ObjectBuilder<FindFieldStructureRequest>> fn)	Find the structure of a text field.
CompletableFuture<FindMessageStructureResponse>	findMessageStructure(FindMessageStructureRequest request)	Find the structure of text messages.
final CompletableFuture<FindMessageStructureResponse>	findMessageStructure(Function<FindMessageStructureRequest.Builder,ObjectBuilder<FindMessageStructureRequest>> fn)	Find the structure of text messages.
CompletableFuture<TestGrokPatternResponse>	testGrokPattern(TestGrokPatternRequest request)	Test a Grok pattern.
final CompletableFuture<TestGrokPatternResponse>	testGrokPattern(Function<TestGrokPatternRequest.Builder,ObjectBuilder<TestGrokPatternRequest>> fn)	Test a Grok pattern.
ElasticsearchTextStructureAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchTextStructureAsyncClient

public ElasticsearchTextStructureAsyncClient(ElasticsearchTransport transport)

ElasticsearchTextStructureAsyncClient

public ElasticsearchTextStructureAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchTextStructureAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchTextStructureAsyncClient>

findFieldStructure

public CompletableFuture<FindFieldStructureResponse> findFieldStructure(FindFieldStructureRequest request)

Find the structure of a text field. Find the structure of a text field in an Elasticsearch index.

See Also:

• Documentation on elastic.co

findFieldStructure

public final CompletableFuture<FindFieldStructureResponse> findFieldStructure(Function<FindFieldStructureRequest.Builder,ObjectBuilder<FindFieldStructureRequest>> fn)

Find the structure of a text field. Find the structure of a text field in an Elasticsearch index.

Parameters:

fn - a function that initializes a builder to create the FindFieldStructureRequest

See Also:

• Documentation on elastic.co

findMessageStructure

public CompletableFuture<FindMessageStructureResponse> findMessageStructure(FindMessageStructureRequest request)

Find the structure of text messages. Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. The response from the API contains:

• Sample messages.
• Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.
• Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.

All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.

See Also:

• Documentation on elastic.co

findMessageStructure

public final CompletableFuture<FindMessageStructureResponse> findMessageStructure(Function<FindMessageStructureRequest.Builder,ObjectBuilder<FindMessageStructureRequest>> fn)

Find the structure of text messages. Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. The response from the API contains:

• Sample messages.
• Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.
• Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.

All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.

Parameters:

fn - a function that initializes a builder to create the FindMessageStructureRequest

See Also:

• Documentation on elastic.co

testGrokPattern

public CompletableFuture<TestGrokPatternResponse> testGrokPattern(TestGrokPatternRequest request)

Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.

See Also:

• Documentation on elastic.co

testGrokPattern

public final CompletableFuture<TestGrokPatternResponse> testGrokPattern(Function<TestGrokPatternRequest.Builder,ObjectBuilder<TestGrokPatternRequest>> fn)

Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.

Parameters:

fn - a function that initializes a builder to create the TestGrokPatternRequest

See Also:

• Documentation on elastic.co