Package com.atlan.model.fields

Interface ITextSearchable

All Known Implementing Classes:
InternalKeywordTextField, KeywordTextField, KeywordTextStemmedField, TextField
public interface ITextSearchable

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getTextFieldName()
    Returns the name of the text field index for this attribute in Elastic.
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    match(String value)
    Returns a query that will textually match the provided value against the field.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    match(String field, String value)
    Returns a query that will textually match the provided value against the field.

  • Method Details

    • getTextFieldName

      String getTextFieldName()
      Returns the name of the text field index for this attribute in Elastic.
      Returns:
      the field name for the text index on this attribute

    • match

      co.elastic.clients.elasticsearch._types.query_dsl.Query match(String value)
      Returns a query that will textually match the provided value against the field. This analyzes the provided value according to the same analysis carried out on the field (for example, tokenization, stemming, and so on).
      Parameters:
      value - the string value to match against
      Returns:
      a query that will only match assets whose analyzed value for the field matches the value provided (which will also be analyzed)

    • match

      static co.elastic.clients.elasticsearch._types.query_dsl.Query match(String field, String value)
      Returns a query that will textually match the provided value against the field. This analyzes the provided value according to the same analysis carried out on the field (for example, tokenization, stemming, and so on).
      Parameters:
      field - name of the field to search
      value - the string value to match against
      Returns:
      a query that will only match assets whose analyzed value for the field matches the value provided (which will also be analyzed)