Module bus.gitlab
Package org.miaixz.bus.gitlab.models

Class ProjectGroupsFilter

java.lang.Object
org.miaixz.bus.gitlab.models.ProjectGroupsFilter
All Implemented Interfaces:
Serializable
public class ProjectGroupsFilter extends Object implements Serializable
This class is used to filter Groups when getting lists of groups for a specified project.
See Also:

  • Constructor Details

    • ProjectGroupsFilter

      public ProjectGroupsFilter()

  • Method Details

    • withSearch

      public ProjectGroupsFilter withSearch(String search)
      Search for specific groups.
      Parameters:
      search - the search criteria
      Returns:
      the reference to this ProjectGroupsFilter instance

    • withSharedMinAccessLevel

      public ProjectGroupsFilter withSharedMinAccessLevel(AccessLevel sharedMinAccessLevel)
      Limit to shared groups with at least this role.
      Parameters:
      sharedMinAccessLevel - the minimal role
      Returns:
      the reference to this ProjectGroupsFilter instance

    • withSharedVisibleOnly

      public ProjectGroupsFilter withSharedVisibleOnly(Boolean sharedVisibleOnly)
      Limit to shared groups user has access to.
      Parameters:
      sharedVisibleOnly - if true limit to the shared groups user has access to.
      Returns:
      the reference to this ProjectGroupsFilter instance

    • withSkipGroups

      public ProjectGroupsFilter withSkipGroups(List<Long> skipGroups)
      Do not include the provided groups IDs.
      Parameters:
      skipGroups - List of group IDs to not include in the search
      Returns:
      the reference to this ProjectGroupsFilter instance

    • withWithShared

      public ProjectGroupsFilter withWithShared(Boolean withShared)
      Include projects shared with this group.
      Parameters:
      withShared - if true include projects shared with this group.
      Returns:
      the reference to this ProjectGroupsFilter instance

    • getQueryParams

      public GitLabForm getQueryParams()
      Get the query params specified by this filter.
      Returns:
      a GitLabApiForm instance holding the query parameters for this ProjectGroupsFilter instance