Class Filter

    • Method Detail

      • fieldAsString

        public final String fieldAsString()

        The field on which to filter.

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

        Returns:
        The field on which to filter.
        See Also:
        FilterField
      • operator

        public final FilterOperator operator()

        The operator to use for comparing the field’s value with the provided value.

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

        Returns:
        The operator to use for comparing the field’s value with the provided value.
        See Also:
        FilterOperator
      • operatorAsString

        public final String operatorAsString()

        The operator to use for comparing the field’s value with the provided value.

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

        Returns:
        The operator to use for comparing the field’s value with the provided value.
        See Also:
        FilterOperator
      • value

        public final String value()

        The desired field value on which to filter.

        Returns:
        The desired field value on which to filter.
      • 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)