Package org.gitlab4j.api.models

Class GroupProjectsFilter

  • All Implemented Interfaces:
    java.io.Serializable
    public class GroupProjectsFilter
extends java.lang.Object
implements java.io.Serializable
    This class is used to filter Projects when getting lists of projects for a specified group.
    See Also:
    Serialized Form

    • Constructor Detail

      • GroupProjectsFilter

        public GroupProjectsFilter()

    • Method Detail

      • withArchived

        public GroupProjectsFilter withArchived​(java.lang.Boolean archived)
        Limit by archived status.
        Parameters:
        archived - if true will only return archived projects
        Returns:
        the reference to this ProjectFilter instance

      • withVisibility

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

      • withOrderBy

        public GroupProjectsFilter withOrderBy​(Constants.ProjectOrderBy orderBy)
        Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields. Default is created_at.
        Parameters:
        orderBy - specifies what field to order by
        Returns:
        the reference to this ProjectFilter instance

      • withSortOder

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

      • withSearch

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

      • withSimple

        public GroupProjectsFilter withSimple​(java.lang.Boolean simple)
        Return only limited fields for each project. This is a no-op without authentication as then only simple fields are returned.
        Parameters:
        simple - if true, return only limited fields for each project
        Returns:
        the reference to this ProjectFilter instance

      • withOwned

        public GroupProjectsFilter withOwned​(java.lang.Boolean owned)
        Limit by projects explicitly owned by the current user
        Parameters:
        owned - if true, limit to projects explicitly owned by the current user
        Returns:
        the reference to this ProjectFilter instance

      • withStarred

        public GroupProjectsFilter withStarred​(java.lang.Boolean starred)
        Limit by projects starred by the current user.
        Parameters:
        starred - if true, limit by projects starred by the current user
        Returns:
        the reference to this ProjectFilter instance

      • withCustomAttributes

        public GroupProjectsFilter 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 ProjectFilter instance

      • withIssuesEnabled

        public GroupProjectsFilter withIssuesEnabled​(java.lang.Boolean withIssuesEnabled)
        Limit by enabled issues feature
        Parameters:
        withIssuesEnabled - if true, limit by enabled issues feature
        Returns:
        the reference to this ProjectFilter instance

      • withMergeRequestsEnabled

        public GroupProjectsFilter withMergeRequestsEnabled​(java.lang.Boolean withMergeRequestsEnabled)
        Limit by enabled merge requests feature
        Parameters:
        withMergeRequestsEnabled - if true, imit by enabled merge requests feature
        Returns:
        the reference to this ProjectFilter instance

      • withIncludeSubGroups

        public GroupProjectsFilter withIncludeSubGroups​(java.lang.Boolean includeSubGroups)
        Include projects that are located in subgroups
        Parameters:
        includeSubGroups - if true, projects from subgroups will be included
        Returns:
        the reference to this ProjectFilter instance

      • withShared

        public GroupProjectsFilter withShared​(java.lang.Boolean withShared)
        Include projects that are shared with this group
        Parameters:
        withShared - if true, projects that are shared with this group will be included
        Returns:
        the reference to this ProjectFilter instance

      • getQueryParams

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

      • toString

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