Class AttributeFilter

    • Method Detail

      • hasAndAllFilters

        public final boolean hasAndAllFilters()
        For responses, this returns true if the service returned a value for the AndAllFilters 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.
      • andAllFilters

        public final List<AttributeFilter> andAllFilters()

        Performs a logical AND operation on all supplied filters.

        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 hasAndAllFilters() method.

        Returns:
        Performs a logical AND operation on all supplied filters.
      • hasOrAllFilters

        public final boolean hasOrAllFilters()
        For responses, this returns true if the service returned a value for the OrAllFilters 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.
      • orAllFilters

        public final List<AttributeFilter> orAllFilters()

        Performs a logical OR operation on all supplied filters.

        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 hasOrAllFilters() method.

        Returns:
        Performs a logical OR operation on all supplied filters.
      • notFilter

        public final AttributeFilter notFilter()

        Performs a logical NOT operation on all supplied filters.

        Returns:
        Performs a logical NOT operation on all supplied filters.
      • equalsTo

        public final DocumentAttribute equalsTo()

        Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

        Returns:
        Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
      • containsAll

        public final DocumentAttribute containsAll()

        Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

        Returns:
        Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
      • containsAny

        public final DocumentAttribute containsAny()

        Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

        Returns:
        Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
      • greaterThan

        public final DocumentAttribute greaterThan()

        Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

        Returns:
        Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
      • greaterThanOrEquals

        public final DocumentAttribute greaterThanOrEquals()

        Performs a greater than or equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

        Returns:
        Performs a greater than or equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
      • lessThan

        public final DocumentAttribute lessThan()

        Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

        Returns:
        Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
      • lessThanOrEquals

        public final DocumentAttribute lessThanOrEquals()

        Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

        Returns:
        Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
      • 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)