Package software.amazon.awssdk.services.qbusiness.model

Class AttributeFilter

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.AttributeFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AttributeFilter.Builder,AttributeFilter>
@Generated("software.amazon.awssdk:codegen") public final class AttributeFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AttributeFilter.Builder,AttributeFilter>

Enables filtering of responses based on document attributes or metadata fields.

See Also:

  • Method Details

    • 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: dateValue, longValue, stringListValue and stringValue.

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

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

      Returns:
      Performs a greater or equals than 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.

    • toBuilder

      public AttributeFilter.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AttributeFilter.Builder,AttributeFilter>
      Returns:
      a builder for type T

    • builder

      public static AttributeFilter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AttributeFilter.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.