Package org.aoju.bus.gitlab.models

Class GroupProjectsFilter

java.lang.Object

org.aoju.bus.gitlab.models.GroupProjectsFilter

public class GroupProjectsFilter
extends Object

This class is used to filter Projects when getting lists of projects for a specified group.

Constructor Summary

Constructors

Constructor	Description
GroupProjectsFilter()

Method Summary

Modifier and Type	Method	Description
GitLabApiForm	getQueryParams()	Get the query params specified by this filter.
GroupProjectsFilter	withArchived(Boolean archived)	Limit by archived status.
GroupProjectsFilter	withCustomAttributes(Boolean withCustomAttributes)	Include custom attributes in response (admins only).
GroupProjectsFilter	withIncludeSubGroups(Boolean includeSubGroups)	Include projects that are located in subgroups
GroupProjectsFilter	withIssuesEnabled(Boolean withIssuesEnabled)	Limit by enabled issues feature
GroupProjectsFilter	withMergeRequestsEnabled(Boolean withMergeRequestsEnabled)	Limit by enabled merge requests feature
GroupProjectsFilter	withOrderBy(Constants.ProjectOrderBy orderBy)	Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields.
GroupProjectsFilter	withOwned(Boolean owned)	Limit by projects explicitly owned by the current user
GroupProjectsFilter	withSearch(String search)	Return list of projects matching the search criteria.
GroupProjectsFilter	withShared(Boolean withShared)	Include projects that are shared with this group
GroupProjectsFilter	withSimple(Boolean simple)	Return only limited fields for each project.
GroupProjectsFilter	withSortOder(Constants.SortOrder sort)	Return projects sorted in asc or desc order.
GroupProjectsFilter	withStarred(Boolean starred)	Limit by projects starred by the current user.
GroupProjectsFilter	withVisibility(Visibility visibility)	Limit by visibility public, internal, or private.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GroupProjectsFilter

public GroupProjectsFilter()

Method Details

withArchived

public GroupProjectsFilter withArchived(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(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(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(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(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(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(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(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(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(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 GitLabApiForm getQueryParams()

Get the query params specified by this filter.

Returns:

a GitLabApiForm instance holding the query parameters for this ProjectFilter instance