Package com.atlan.model.lineage

Class LineageFilterFieldCM

java.lang.Object
com.atlan.model.lineage.LineageFilterField
com.atlan.model.lineage.LineageFilterFieldCM
public class LineageFilterFieldCM extends LineageFilterField
Class used to provide a proxy to building up a lineage filter with the appropriate subset of conditions available, for custom metadata fields.

  • Field Summary

    Fields inherited from class com.atlan.model.lineage.LineageFilterField

    field

  • Constructor Summary

    Constructors
    Constructor
    Description
    LineageFilterFieldCM(CustomMetadataField field)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    LineageFilter
    contains(String value)
    Returns a filter that will match all assets whose provided field has a value that contains the provided value.
    LineageFilter
    doesNotContain(String value)
    Returns a filter that will match all assets whose provided field has a value that does not contain the provided value.
    LineageFilter
    endsWith(String value)
    Returns a filter that will match all assets whose provided field has a value that ends with the provided value.
    LineageFilter
    eq(AtlanEnum value)
    Returns a filter that will match all assets whose provided field has a value that is exactly the provided value.
    LineageFilter
    eq(Boolean value)
    Returns a filter that will match all assets whose provided field has a value that is exactly the provided value.
    LineageFilter
    eq(String value)
    Returns a filter that will match all assets whose provided field has a value that is exactly the provided value.
    <T extends Number>
    LineageFilter
    eq(T value)
    Returns a filter that will match all assets whose provided field has a value that is exactly the provided value.
    CustomMetadataField
    getCmField()
     
    <T extends Number>
    LineageFilter
    gt(T value)
    Returns a filter that will match all assets whose provided field has a value that is strictly greater than the provided value.
    <T extends Number>
    LineageFilter
    gte(T value)
    Returns a filter that will match all assets whose provided field has a value that is greater than or equal to the provided value.
    <T extends Number>
    LineageFilter
    lt(T value)
    Returns a filter that will match all assets whose provided field has a value that is strictly less than the provided value.
    <T extends Number>
    LineageFilter
    lte(T value)
    Returns a filter that will match all assets whose provided field has a value that is less than or equal to the provided value.
    LineageFilter
    neq(AtlanEnum value)
    Returns a filter that will match all assets whose provided field has a value that is not exactly the provided value.
    LineageFilter
    neq(Boolean value)
    Returns a filter that will match all assets whose provided field has a value that is not exactly the provided value.
    LineageFilter
    neq(String value)
    Returns a filter that will match all assets whose provided field has a value that is not exactly the provided value.
    <T extends Number>
    LineageFilter
    neq(T value)
    Returns a filter that will match all assets whose provided field has a value that is not exactly the provided value.
    LineageFilter
    startsWith(String value)
    Returns a filter that will match all assets whose provided field has a value that starts with the provided value.

    Methods inherited from class com.atlan.model.lineage.LineageFilterField

    build, getField, hasAnyValue, hasNoValue

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • eq

      public LineageFilter eq(String value)
      Returns a filter that will match all assets whose provided field has a value that is exactly the provided value. Note that this is a case-sensitive match.
      Parameters:
      value - the value to check the field's value equals (case-sensitive)
      Returns:
      a filter that will only match assets whose value for the field is exactly the value provided

    • eq

      public LineageFilter eq(AtlanEnum value)
      Returns a filter that will match all assets whose provided field has a value that is exactly the provided value. Note that this is a case-sensitive match.
      Parameters:
      value - the value to check the field's value equals (case-sensitive)
      Returns:
      a filter that will only match assets whose value for the field is exactly the value provided

    • neq

      public LineageFilter neq(String value)
      Returns a filter that will match all assets whose provided field has a value that is not exactly the provided value. Note that this is a case-sensitive match.
      Parameters:
      value - the value to check the field's value does not equal (case-sensitive)
      Returns:
      a filter that will only match assets whose value for the field is not exactly the value provided

    • neq

      public LineageFilter neq(AtlanEnum value)
      Returns a filter that will match all assets whose provided field has a value that is not exactly the provided value. Note that this is a case-sensitive match.
      Parameters:
      value - the value to check the field's value does not equal (case-sensitive)
      Returns:
      a filter that will only match assets whose value for the field is not exactly the value provided

    • startsWith

      public LineageFilter startsWith(String value) throws InvalidRequestException
      Returns a filter 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 filter that will only match assets whose value for the field starts with the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not string-comparable

    • endsWith

      public LineageFilter endsWith(String value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that ends with the provided value. Note that this is a case-sensitive match.
      Parameters:
      value - the value (suffix) to check the field's value ends with (case-sensitive)
      Returns:
      a filter that will only match assets whose value for the field ends with the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not string-comparable

    • contains

      public LineageFilter contains(String value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that contains the provided value. Note that this is a case-sensitive match.
      Parameters:
      value - the value to check the field's value contains (case-sensitive)
      Returns:
      a filter that will only match assets whose value for the field contains the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not string-comparable

    • doesNotContain

      public LineageFilter doesNotContain(String value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that does not contain the provided value. Note that this is a case-sensitive match.
      Parameters:
      value - the value to check the field's value does not contain (case-sensitive)
      Returns:
      a filter that will only match assets whose value for the field does not contain the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not string-comparable

    • lt

      public <T extends Number> LineageFilter lt(T value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that is strictly less than the provided value.
      Parameters:
      value - the value to check the field's value is strictly less than
      Returns:
      a filter that will only match assets whose value for the field is strictly less than the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not numerically-comparable

    • gt

      public <T extends Number> LineageFilter gt(T value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that is strictly greater than the provided value.
      Parameters:
      value - the value to check the field's value is strictly greater than
      Returns:
      a filter that will only match assets whose value for the field is strictly greater than the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not numerically-comparable

    • lte

      public <T extends Number> LineageFilter lte(T value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that is less than or equal to the provided value.
      Parameters:
      value - the value to check the field's value is less than or equal to
      Returns:
      a filter that will only match assets whose value for the field is less than or equal to the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not numerically-comparable

    • gte

      public <T extends Number> LineageFilter gte(T value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that is greater than or equal to the provided value.
      Parameters:
      value - the value to check the field's value is greater than or equal to
      Returns:
      a filter that will only match assets whose value for the field is greater than or equal to the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not numerically-comparable

    • eq

      public <T extends Number> LineageFilter eq(T value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that is exactly the provided value.
      Parameters:
      value - the value to check the field's value equals
      Returns:
      a filter that will only match assets whose value for the field is exactly the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not numerically-comparable

    • neq

      public <T extends Number> LineageFilter neq(T value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that is not exactly the provided value.
      Parameters:
      value - the value to check the field's value does not equal
      Returns:
      a filter that will only match assets whose value for the field is not exactly the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not numerically-comparable

    • eq

      public LineageFilter eq(Boolean value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that is exactly the provided value.
      Parameters:
      value - the value to check the field's value equals
      Returns:
      a filter that will only match assets whose value for the field is exactly the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not boolean-comparable

    • neq

      public LineageFilter neq(Boolean value) throws InvalidRequestException
      Returns a filter that will match all assets whose provided field has a value that is not exactly the provided value.
      Parameters:
      value - the value to check the field's value does not equal
      Returns:
      a filter that will only match assets whose value for the field is not exactly the value provided
      Throws:
      InvalidRequestException - if the custom metadata field is not boolean-comparable

    • getCmField

      public CustomMetadataField getCmField()