Package org.elasticsearch.client.indices

Class AnalyzeRequest

java.lang.Object
org.elasticsearch.client.indices.AnalyzeRequest
All Implemented Interfaces:
Validatable, ToXContent, ToXContentObject
public class AnalyzeRequest
extends java.lang.Object
implements Validatable, ToXContentObject
A request to analyze text

  • Method Details

    • withGlobalAnalyzer

      public static AnalyzeRequest withGlobalAnalyzer​(java.lang.String analyzer, java.lang.String... text)
      Analyzes text using a global analyzer

    • buildCustomAnalyzer

      public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomAnalyzer​(java.lang.String tokenizer)
      Analyzes text using a custom analyzer built from global components

    • buildCustomAnalyzer

      public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomAnalyzer​(java.util.Map<java.lang.String,​java.lang.Object> tokenizerSettings)
      Analyzes text using a custom analyzer built from global components

    • buildCustomAnalyzer

      public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomAnalyzer​(java.lang.String index, java.lang.String tokenizer)
      Analyzes text using a custom analyzer built from components defined on an index

    • buildCustomAnalyzer

      public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomAnalyzer​(java.lang.String index, java.util.Map<java.lang.String,​java.lang.Object> tokenizerSettings)
      Analyzes text using a custom analyzer built from components defined on an index

    • withIndexAnalyzer

      public static AnalyzeRequest withIndexAnalyzer​(java.lang.String index, java.lang.String analyzer, java.lang.String... text)
      Analyzes text using a named analyzer on an index

    • withField

      public static AnalyzeRequest withField​(java.lang.String index, java.lang.String field, java.lang.String... text)
      Analyzes text using the analyzer defined on a specific field within an index

    • withNormalizer

      public static AnalyzeRequest withNormalizer​(java.lang.String index, java.lang.String normalizer, java.lang.String... text)
      Analyzes text using a named normalizer on an index

    • buildCustomNormalizer

      public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomNormalizer()
      Analyzes text using a custom normalizer built from global components

    • buildCustomNormalizer

      public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomNormalizer​(java.lang.String index)
      Analyzes text using a custom normalizer built from components defined on an index

    • index

      public java.lang.String index()
      Returns the index that the request should be executed against, or null if no index is specified

    • text

      public java.lang.String[] text()
      Returns the text to be analyzed

    • analyzer

      public java.lang.String analyzer()
      Returns the named analyzer used for analysis, if defined

    • normalizer

      public java.lang.String normalizer()
      Returns the named tokenizer used for analysis, if defined

    • tokenizer

      public org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition tokenizer()
      Returns a custom Tokenizer used for analysis, if defined

    • tokenFilters

      public java.util.List<org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition> tokenFilters()
      Returns the custom token filters used for analysis, if defined

    • charFilters

      public java.util.List<org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition> charFilters()
      Returns the custom character filters used for analysis, if defined

    • field

      public java.lang.String field()
      Returns the field to take an Analyzer from, if defined

    • explain

      public AnalyzeRequest explain​(boolean explain)
      Set whether or not detailed explanations of analysis should be returned

    • explain

      public boolean explain()

    • attributes

      public AnalyzeRequest attributes​(java.lang.String... attributes)

    • attributes

      public java.lang.String[] attributes()

    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      java.io.IOException