Class UserSearchFilter

java.lang.Object
software.amazon.awssdk.services.connect.model.UserSearchFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserSearchFilter.Builder,UserSearchFilter>

@Generated("software.amazon.awssdk:codegen") public final class UserSearchFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserSearchFilter.Builder,UserSearchFilter>

Filters to be applied to search results.

See Also:
  • Method Details

    • tagFilter

      public final ControlPlaneTagFilter tagFilter()
      Returns the value of the TagFilter property for this object.
      Returns:
      The value of the TagFilter property for this object.
    • userAttributeFilter

      public final ControlPlaneUserAttributeFilter userAttributeFilter()

      An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

      This accepts an OR of AND (List of List) input where:

      • The top level list specifies conditions that need to be applied with OR operator.

      • The inner list specifies conditions that need to be applied with AND operator.

      Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

      Returns:
      An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

      This accepts an OR of AND (List of List) input where:

      • The top level list specifies conditions that need to be applied with OR operator.

      • The inner list specifies conditions that need to be applied with AND operator.

      Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

    • toBuilder

      public UserSearchFilter.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<UserSearchFilter.Builder,UserSearchFilter>
      Returns:
      a builder for type T
    • builder

      public static UserSearchFilter.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UserSearchFilter.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.