Class StringFilterField


public class StringFilterField extends ExactMatchFilterField
Represents any field in Atlan that can be used for discovery by string comparisons.
  • Constructor Details

    • StringFilterField

      public StringFilterField(String field)
      Default constructor
      Parameters:
      field - name of the field to filter by (singular)
    • StringFilterField

      public StringFilterField(List<String> fields)
      Default constructor
      Parameters:
      fields - names of the fields to filter by (multiple)
  • Method Details

    • startsWith

      public DiscoveryFilter startsWith(String value)
      Returns a query that will match all assets whose provided field has a value that starts with the provided value.
      Parameters:
      value - the value to check the field's value starts with
      Returns:
      a query that will only match assets whose value for the field starts with the provided value
    • endsWith

      public DiscoveryFilter endsWith(String value)
      Returns a query that will match all assets whose provided field has a value that ends with the provided value.
      Parameters:
      value - the value to check the field's value ends with
      Returns:
      a query that will only match assets whose value for the field ends with the provided value
    • contains

      public DiscoveryFilter contains(String value)
      Returns a query that will match all assets whose provided field has a value that contains the provided value.
      Parameters:
      value - the value to check the field's value contains
      Returns:
      a query that will only match assets whose value for the field contains the provided value
    • doesNotContain

      public DiscoveryFilter doesNotContain(String value)
      Returns a query that will match all assets whose provided field has a value that does not contain the provided value.
      Parameters:
      value - the value to check the field's value does NOT contain
      Returns:
      a query that will only match assets whose value for the field does not contain the provided value
    • regex

      public DiscoveryFilter regex(String value)
      Returns a query that will match all assets whose provided field has a value that matches the provided regular expression pattern.
      Parameters:
      value - the regular expression to check the field's value matches
      Returns:
      a query that will only match assets whose value for the field matches the provided regular expression