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.

  • Constructor Details

  • 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.

      This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just @timestamp and message fields, you can use this API to see what common structure exists in the message field.

      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.

      If the structure finder produces unexpected results, specify the explain query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen.

      See Also:

    • 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.

      This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just @timestamp and message fields, you can use this API to see what common structure exists in the message field.

      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.

      If the structure finder produces unexpected results, specify the explain query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen.

      Parameters:
      fn - a function that initializes a builder to create the FindFieldStructureRequest
      See Also:

    • 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.

      If the structure finder produces unexpected results, specify the explain query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen.

      See Also:

    • 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.

      If the structure finder produces unexpected results, specify the explain query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen.

      Parameters:
      fn - a function that initializes a builder to create the FindMessageStructureRequest
      See Also:

    • 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:

    • 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: