org.gitlab4j.api.models

Class PackageFilter

java.lang.Object

org.gitlab4j.api.models.PackageFilter

public class PackageFilter
extends Object

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

Constructor Summary

Constructors

Constructor and Description
PackageFilter()

Method Summary

Modifier and Type	Method and Description
GitLabApiForm	getQueryParams() Get the query params specified by this filter.
PackageFilter	withExcludeSubgroups(Boolean excludeSubgroups) Exclude Subgroups.
PackageFilter	withIncludeVersionless(Boolean includeVersionless)
PackageFilter	withOrderBy(Constants.PackageOrderBy orderBy) Return projects ordered by created_at, name, version, type, or project_path
PackageFilter	withPackageName(String packageName) Filter the project packages with a fuzzy search by name
PackageFilter	withPackageType(PackageType packageType) Filter the returned packages by type.
PackageFilter	withSortOder(Constants.SortOrder sort) Return projects sorted in asc or desc order.
PackageFilter	withStatus(Constants.PackageStatus status) Filter the returned packages by status.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageFilter

public PackageFilter()

Method Detail

withExcludeSubgroups

public PackageFilter withExcludeSubgroups(Boolean excludeSubgroups)

Exclude Subgroups.

Parameters:

excludeSubgroups - if true, packages from projects from subgroups are not listed.

Returns:

the reference to this ProjectFilter instance

withOrderBy

public PackageFilter withOrderBy(Constants.PackageOrderBy orderBy)

Return projects ordered by created_at, name, version, type, or project_path

Parameters:

orderBy - specifies what field to order by

Returns:

the reference to this ProjectFilter instance

withSortOder

public PackageFilter 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

withPackageType

public PackageFilter withPackageType(PackageType packageType)

Filter the returned packages by type.

Parameters:

packageType - One of conan, maven, npm, pypi, composer, nuget, helm, generic or golang

Returns:

the reference to this ProjectFilter instance

withPackageName

public PackageFilter withPackageName(String packageName)

Filter the project packages with a fuzzy search by name

Parameters:

packageName -

Returns:

the reference to this ProjectFilter instance

withIncludeVersionless

public PackageFilter withIncludeVersionless(Boolean includeVersionless)

Parameters:

includeVersionless - if true, versionless packages are included in the response

Returns:

the reference to this ProjectFilter instance

withStatus

public PackageFilter withStatus(Constants.PackageStatus status)

Filter the returned packages by status.

Parameters:

status - One of default (default), hidden, or processing

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