Class Filter

    • Method Detail

      • name

        public final String name()

        The name of the transform node.

        Returns:
        The name of the transform node.
      • hasInputs

        public final boolean hasInputs()
        For responses, this returns true if the service returned a value for the Inputs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • inputs

        public final List<String> inputs()

        The data inputs identified by their node names.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInputs() method.

        Returns:
        The data inputs identified by their node names.
      • logicalOperatorAsString

        public final String logicalOperatorAsString()

        The operator used to filter rows by comparing the key value to a specified value.

        If the service returns an enum value that is not available in the current SDK version, logicalOperator will return FilterLogicalOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logicalOperatorAsString().

        Returns:
        The operator used to filter rows by comparing the key value to a specified value.
        See Also:
        FilterLogicalOperator
      • hasFilters

        public final boolean hasFilters()
        For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • filters

        public final List<FilterExpression> filters()

        Specifies a filter expression.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

        Returns:
        Specifies a filter expression.
      • serializableBuilderClass

        public static Class<? extends Filter.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)