com.talanlabs.gitlab.api.v3.services

Class GitLabAPIProjects

java.lang.Object

com.talanlabs.gitlab.api.v3.services.GitLabAPIProjects

public class GitLabAPIProjects
extends Object

Commits API

http://doc.gitlab.com/ce/api/commits.html

Constructor Summary

Constructors

Constructor and Description
GitLabAPIProjects(GitLabAPI gitLabAPI)

Method Summary

Modifier and Type	Method and Description
GitLabProject	getProject(Serializable projectId) Get single project
Paged<GitLabProject>	getProjectAlls(Pagination pagination, Boolean archived, String orderBy, String sort, String search, Boolean ciEnabledFirst) List ALL projects
Paged<GitLabProject>	getProjectOwneds(Pagination pagination, Boolean archived, String orderBy, String sort, String search, Boolean ciEnabledFirst) List owned projects
Paged<GitLabProject>	getProjects(Pagination pagination, Boolean archived, String orderBy, String sort, String search, Boolean ciEnabledFirst) List projects
Paged<GitLabProject>	getProjectsSearchByName(String query, Pagination pagination, String orderBy, String sort) Search for projects by name

Methods inherited from class java.lang.Object

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

Constructor Detail

GitLabAPIProjects

public GitLabAPIProjects(GitLabAPI gitLabAPI)

Method Detail

getProjects

public Paged<GitLabProject> getProjects(Pagination pagination,
                                        Boolean archived,
                                        String orderBy,
                                        String sort,
                                        String search,
                                        Boolean ciEnabledFirst)
                                 throws IOException

List projects

Get a list of projects accessible by the authenticated user.

GET /projects

Parameters:

pagination - (optional) - number of projects to return per page

archived - (optional) - if passed, limit by archived status

orderBy - (optional) - Return requests ordered by id, name, path, created_at, updated_at or last_activity_at fields. Default is created_at

sort - (optional) - Return requests sorted in asc or desc order. Default is desc

search - (optional) - Return list of authorized projects according to a search criteria

ciEnabledFirst - (optional) - Return projects ordered by ci_enabled flag. Projects with enabled GitLab CI go first

Returns:

Throws:

IOException

getProjectOwneds

public Paged<GitLabProject> getProjectOwneds(Pagination pagination,
                                             Boolean archived,
                                             String orderBy,
                                             String sort,
                                             String search,
                                             Boolean ciEnabledFirst)
                                      throws IOException

List owned projects

Get a list of projects which are owned by the authenticated user.

GET /projects/owned

Parameters:

pagination - (optional) - number of projects to return per page

archived - (optional) - if passed, limit by archived status

orderBy - (optional) - Return requests ordered by id, name, path, created_at, updated_at or last_activity_at fields. Default is created_at

sort - (optional) - Return requests sorted in asc or desc order. Default is desc

search - (optional) - Return list of authorized projects according to a search criteria

ciEnabledFirst - (optional) - Return projects ordered by ci_enabled flag. Projects with enabled GitLab CI go first

Returns:

Throws:

IOException

getProjectAlls

public Paged<GitLabProject> getProjectAlls(Pagination pagination,
                                           Boolean archived,
                                           String orderBy,
                                           String sort,
                                           String search,
                                           Boolean ciEnabledFirst)
                                    throws IOException

List ALL projects

Get a list of all GitLab projects (admin only).

GET /projects/all

Parameters:

pagination - (optional) - number of projects to return per page

archived - (optional) - if passed, limit by archived status

orderBy - (optional) - Return requests ordered by id, name, path, created_at, updated_at or last_activity_at fields. Default is created_at

sort - (optional) - Return requests sorted in asc or desc order. Default is desc

search - (optional) - Return list of authorized projects according to a search criteria

ciEnabledFirst - (optional) - Return projects ordered by ci_enabled flag. Projects with enabled GitLab CI go first

Returns:

Throws:

IOException

getProject

public GitLabProject getProject(Serializable projectId)
                         throws IOException

Get single project

Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME, which is owned by the authenticated user. If using namespaced projects call make sure that the NAMESPACE/PROJECT_NAME is URL-encoded, eg. /api/v3/projects/diaspora%2Fdiaspora (where / is represented by %2F).

GET /projects/:id

Parameters:

projectId - (required) - The ID of a project

Returns:

Throws:

IOException

getProjectsSearchByName

public Paged<GitLabProject> getProjectsSearchByName(String query,
                                                    Pagination pagination,
                                                    String orderBy,
                                                    String sort)
                                             throws IOException

Search for projects by name

Search for projects by name which are accessible to the authenticated user.

GET /projects/search/:query

Parameters:

query - (required) - A string contained in the project name

pagination - (optional) - number of projects to return per page

orderBy - (optional) - Return requests ordered by id, name, created_at or last_activity_at fields

sort - (optional) - Return requests sorted in asc or desc order

Returns:

Throws:

IOException