Package com.atlan.model.fields

Interface IKeywordSearchable

All Known Implementing Classes:
InternalKeywordField, InternalKeywordTextField, KeywordField, KeywordTextField, KeywordTextStemmedField
public interface IKeywordSearchable

  • Method Summary

    Modifier and Type
    Method
    Description
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    eq(AtlanEnum value)
    Returns a query that will match all assets whose provided field has a value that exactly equals the provided enumerated value.
    default co.elastic.clients.elasticsearch._types.query_dsl.Query
    eq(String value)
    Returns a query that will match all assets whose provided field has a value that exactly equals the provided string value.
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    eq(String value, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that exactly equals the provided string value.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    eq(String field, AtlanEnum value)
    Returns a query that will match all assets whose provided field has a value that exactly equals the provided enumerated value.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    eq(String field, String value, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that exactly equals the provided string value.
    String
    getKeywordFieldName()
    Returns the name of the keyword field index for this attribute in Elastic.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    in(String field, Collection<String> values)
    Returns a query that will match all assets whose provided field has a value that exactly equals at least one of the provided string values.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    in(String field, List<String> values, int minMustMatch)
    Returns a query that will match all assets whose provided field has multiple values that exactly equal a specified number of the provided string values.
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    in(Collection<String> values)
    Returns a query that will match all assets whose provided field has a value that exactly equals at least one of the provided string values.
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    in(List<String> values, int minMustMatch)
    Returns a query that will match all assets whose provided field has multiple values that exactly equal a specified number of the provided string values.
    default co.elastic.clients.elasticsearch._types.query_dsl.Query
    regex(String regexp)
    Returns a query that will match all assets whose provided field has a value that matches the regular expression provided.
    default co.elastic.clients.elasticsearch._types.query_dsl.Query
    regex(String regexp, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that matches the regular expression provided.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    regex(String field, String regexp, Collection<ElasticRegexOperator> flags, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that matches the regular expression provided.
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    regex(String regexp, Collection<ElasticRegexOperator> flags, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that matches the regular expression provided.
    default co.elastic.clients.elasticsearch._types.query_dsl.Query
    startsWith(String value)
    Returns a query that will match all assets whose provided field has a value that starts with the provided value.
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    startsWith(String value, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that starts with the provided value.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    startsWith(String field, String value, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that starts with the provided value.
    default co.elastic.clients.elasticsearch._types.query_dsl.Query
    wildcard(String value)
    Returns a query that will match all assets whose provided field has a value that matches the wildcard expression provided.
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    wildcard(String value, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that matches the wildcard expression provided.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    wildcard(String field, String value, boolean caseInsensitive)
    Returns a query that will match all assets whose provided field has a value that matches the wildcard expression provided.

  • Method Details

    • getKeywordFieldName

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

    • startsWith

      default co.elastic.clients.elasticsearch._types.query_dsl.Query startsWith(String value)
      Returns a query that will match all assets whose provided field has a value that starts with the provided value. Note that this is a case-sensitive match.
      Parameters:
      value - the value (prefix) to check the field's value starts with (case-sensitive)
      Returns:
      a query that will only match assets whose value for the field starts with the value provided

    • startsWith

      co.elastic.clients.elasticsearch._types.query_dsl.Query startsWith(String value, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that starts with the provided value. Note that this can also be a case-insensitive match.
      Parameters:
      value - the value (prefix) to check the field's value starts with
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field starts with the value provided

    • startsWith

      static co.elastic.clients.elasticsearch._types.query_dsl.Query startsWith(String field, String value, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that starts with the provided value. Note that this can also be a case-insensitive match.
      Parameters:
      field - name of the field to search
      value - the value (prefix) to check the field's value starts with (case-sensitive)
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field starts with the value provided

    • eq

      co.elastic.clients.elasticsearch._types.query_dsl.Query eq(AtlanEnum value)
      Returns a query that will match all assets whose provided field has a value that exactly equals the provided enumerated value.
      Parameters:
      value - the value (enumerated) to check the field's value is exactly equal to
      Returns:
      a query that will only match assets whose value for the field is exactly equal to the enumerated value provided

    • eq

      static co.elastic.clients.elasticsearch._types.query_dsl.Query eq(String field, AtlanEnum value)
      Returns a query that will match all assets whose provided field has a value that exactly equals the provided enumerated value.
      Parameters:
      field - name of the field to search
      value - the value (enumerated) to check the field's value is exactly equal to
      Returns:
      a query that will only match assets whose value for the field is exactly equal to the enumerated value provided

    • eq

      default co.elastic.clients.elasticsearch._types.query_dsl.Query eq(String value)
      Returns a query that will match all assets whose provided field has a value that exactly equals the provided string value.
      Parameters:
      value - the value (string) to check the field's value is exactly equal to
      Returns:
      a query that will only match assets whose value for the field is exactly equal to the string value provided

    • eq

      co.elastic.clients.elasticsearch._types.query_dsl.Query eq(String value, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that exactly equals the provided string value. Note that this can also be modified to ignore case when doing the exact match.
      Parameters:
      value - the value (string) to check the field's value is exactly equal to
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field is exactly equal to the string value provided (optionally case-insensitive)

    • eq

      static co.elastic.clients.elasticsearch._types.query_dsl.Query eq(String field, String value, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that exactly equals the provided string value. Note that this can also be modified to ignore case when doing the exact match.
      Parameters:
      field - name of the field to search
      value - the value (string) to check the field's value is exactly equal to
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field is exactly equal to the string value provided (optionally case-insensitive)

    • in

      co.elastic.clients.elasticsearch._types.query_dsl.Query in(Collection<String> values)
      Returns a query that will match all assets whose provided field has a value that exactly equals at least one of the provided string values.
      Parameters:
      values - the values (strings) to check the field's value is exactly equal to
      Returns:
      a query that will only match assets whose value for the field is exactly equal to at least one of the string values provided

    • in

      static co.elastic.clients.elasticsearch._types.query_dsl.Query in(String field, Collection<String> values)
      Returns a query that will match all assets whose provided field has a value that exactly equals at least one of the provided string values.
      Parameters:
      field - name of the field to search
      values - the values (strings) to check the field's value is exactly equal to
      Returns:
      a query that will only match assets whose value for the field is exactly equal to at least one of the string values provided
      See Also:

    • in

      co.elastic.clients.elasticsearch._types.query_dsl.Query in(List<String> values, int minMustMatch)
      Returns a query that will match all assets whose provided field has multiple values that exactly equal a specified number of the provided string values.
      Parameters:
      values - the values (strings) to check the field's values are exactly equal to
      minMustMatch - minimum number of values from the provided list that must be contained in the field's values
      Returns:
      a query that will only match assets whose values for the field are exactly equal to a minimal number of the string values provided

    • in

      static co.elastic.clients.elasticsearch._types.query_dsl.Query in(String field, List<String> values, int minMustMatch)
      Returns a query that will match all assets whose provided field has multiple values that exactly equal a specified number of the provided string values.
      Parameters:
      field - name of the field to search
      values - the values (strings) to check the field's values are exactly equal to
      minMustMatch - minimum number of values from the provided list that must be contained in the field's values
      Returns:
      a query that will only match assets whose values for the field are exactly equal to a minimal number of the string values provided
      See Also:

    • wildcard

      default co.elastic.clients.elasticsearch._types.query_dsl.Query wildcard(String value)
      Returns a query that will match all assets whose provided field has a value that matches the wildcard expression provided. This is similar to regex matching, but only allows * (match zero or more characters) and ? (match any single character) operators.
      Parameters:
      value - the value (containing either * or ?) to match against the field's values
      Returns:
      a query that will only match assets whose value for the field matches the wildcard expression provided

    • wildcard

      co.elastic.clients.elasticsearch._types.query_dsl.Query wildcard(String value, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that matches the wildcard expression provided. This is similar to regex matching, but only allows * (match zero or more characters) and ? (match any single character) operators.
      Parameters:
      value - the value (containing either * or ?) to match against the field's values
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field matches the wildcard expression provided

    • wildcard

      static co.elastic.clients.elasticsearch._types.query_dsl.Query wildcard(String field, String value, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that matches the wildcard expression provided. This is similar to regex matching, but only allows * (match zero or more characters) and ? (match any single character) operators.
      Parameters:
      field - name of the field to search
      value - the value (containing either * or ?) to match against the field's values
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field matches the wildcard expression provided
      See Also:

    • regex

      default co.elastic.clients.elasticsearch._types.query_dsl.Query regex(String regexp)
      Returns a query that will match all assets whose provided field has a value that matches the regular expression provided.
      Parameters:
      regexp - regular expression to match values against
      Returns:
      a query that will only match assets whose value for the field matches the regular expression provided

    • regex

      default co.elastic.clients.elasticsearch._types.query_dsl.Query regex(String regexp, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that matches the regular expression provided.
      Parameters:
      regexp - regular expression to match values against
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field matches the regular expression provided

    • regex

      co.elastic.clients.elasticsearch._types.query_dsl.Query regex(String regexp, Collection<ElasticRegexOperator> flags, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that matches the regular expression provided.
      Parameters:
      regexp - regular expression to match values against
      flags - optional set of operators to enable in the regular expression engine
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field matches the regular expression provided

    • regex

      static co.elastic.clients.elasticsearch._types.query_dsl.Query regex(String field, String regexp, Collection<ElasticRegexOperator> flags, boolean caseInsensitive)
      Returns a query that will match all assets whose provided field has a value that matches the regular expression provided.
      Parameters:
      field - name of the field to search
      regexp - regular expression to match values against
      flags - optional set of operators to enable in the regular expression engine
      caseInsensitive - if true will match the value irrespective of case, otherwise will be a case-sensitive match
      Returns:
      a query that will only match assets whose value for the field matches the regular expression provided
      See Also: