Package org.gitlab4j.api.models

Class SharedGroupsFilter

  • All Implemented Interfaces:
    java.io.Serializable
    public class SharedGroupsFilter
extends java.lang.Object
implements java.io.Serializable
    This class is used to filter Groups when getting lists of groups for a specified group where it has been invited.
    See Also:
    Serialized Form

    • Constructor Detail

      • SharedGroupsFilter

        public SharedGroupsFilter()

    • Method Detail

      • withSkipGroups

        public SharedGroupsFilter 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 SharedGroupsFilter instance

      • withSearch

        public SharedGroupsFilter withSearch​(java.lang.String search)
        Return list of groups matching the search criteria.
        Parameters:
        search - the search criteria
        Returns:
        the reference to this SharedGroupsFilter instance

      • withOrderBy

        public SharedGroupsFilter withOrderBy​(Constants.GroupOrderBy orderBy)
        Return groups ordered by name, path, id, or similarity. Default is name.
        Parameters:
        orderBy - specifies what field to order by
        Returns:
        the reference to this SharedGroupsFilter instance

      • withSortOder

        public SharedGroupsFilter withSortOder​(Constants.SortOrder sort)
        Return groups sorted in asc or desc order. Default is desc.
        Parameters:
        sort - sort direction, ASC or DESC
        Returns:
        the reference to this SharedGroupsFilter instance

      • withVisibility

        public SharedGroupsFilter withVisibility​(Visibility visibility)
        Limit by visibility public, internal, or private.
        Parameters:
        visibility - the visibility to match
        Returns:
        the reference to this SharedGroupsFilter instance

      • withMinAccessLevel

        public SharedGroupsFilter withMinAccessLevel​(AccessLevel minAccessLevel)
        Limit to groups where current user has at least the specified role (access_level).
        Parameters:
        minAccessLevel - the minimum access level to match
        Returns:
        the reference to this SharedGroupsFilter instance

      • withCustomAttributes

        public SharedGroupsFilter withCustomAttributes​(java.lang.Boolean withCustomAttributes)
        Include custom attributes in response (admins only).
        Parameters:
        withCustomAttributes - if true, include custom attributes in the repsonse
        Returns:
        the reference to this SharedGroupsFilter instance

      • getQueryParams

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object