Package org.gitlab4j.api.models

Class ProjectGroupsFilter

  • All Implemented Interfaces:
    java.io.Serializable
    public class ProjectGroupsFilter
extends java.lang.Object
implements java.io.Serializable
    This class is used to filter Groups when getting lists of groups for a specified project.
    See Also:
    Serialized Form

    • Constructor Detail

      • ProjectGroupsFilter

        public ProjectGroupsFilter()

    • Method Detail

      • withSearch

        public ProjectGroupsFilter withSearch​(java.lang.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​(java.lang.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​(java.util.List<java.lang.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​(java.lang.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