Package com.collibra.dgc.core.api.dto.usergroup

Class FindUserGroupsRequest

Object
PagedRequest
FindUserGroupsRequest
All Implemented Interfaces:
Serializable
public class FindUserGroupsRequest extends PagedRequest
The search criteria for user groups.

Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

The returned user groups satisfy all constraints that are specified in this search criteria.

By default a result containing 1000 user groups is returned.

See Also:

  • Constructor Details

    • FindUserGroupsRequest

      public FindUserGroupsRequest()

  • Method Details

    • builder

      public static FindUserGroupsRequest.Builder builder()

    • getName

      public String getName()
      The name of the user group.

    • getNameMatchMode

      public MatchMode getNameMatchMode()
      The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive.

    • getUserId

      public UUID getUserId()
      The ID of the user who should belong to searched user groups.

    • isIncludeEveryone

      @Deprecated public boolean isIncludeEveryone()
      Deprecated.
      This search parameter will be removed in the future. In practice setting this value is not enough: there are other system groups like Users that may need to be removed programmatically anyways. System groups cannot be modified (add/remove users) but can be used in the context of assigned responsibilities.
      Indicates if we should include the everyone group or not.

    • setName

      public void setName(String name)
      The name of the user group.

    • setNameMatchMode

      public void setNameMatchMode(MatchMode nameMatchMode)
      The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive.

    • setUserId

      public void setUserId(UUID userId)
      The ID of the user who should belong to searched user groups.

    • setIncludeEveryone

      @Deprecated public void setIncludeEveryone(boolean includeEveryone)
      Deprecated.
      This search parameter will be removed in the future. In practice setting this value is not enough: there are other system groups like Users that may need to be removed programmatically anyways. System groups cannot be modified (add/remove users) but can be used in the context of assigned responsibilities.
      Indicates if we should include the everyone group or not.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class PagedRequest

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class PagedRequest

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PagedRequest

    • toString

      public String toString()
      Overrides:
      toString in class PagedRequest