org.gitlab4j.api

Class NamespaceApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.NamespaceApi

All Implemented Interfaces:

Constants

public class NamespaceApi
extends AbstractApi

This class implements the client side API for the GitLab namespace calls.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DefaultBranchProtectionLevel, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.PipelineSource, Constants.ProjectAccessTokenScope, Constants.ProjectCreationLevel, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.SubgroupCreationLevel, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor and Description
NamespaceApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
java.util.List<Namespace>	findNamespaces(java.lang.String query) Get all namespaces that match a string in their name or path.
Pager<Namespace>	findNamespaces(java.lang.String query, int itemsPerPage) Get a Pager of all namespaces that match a string in their name or path.
java.util.List<Namespace>	findNamespaces(java.lang.String query, int page, int perPage) Get all namespaces that match a string in their name or path in the specified page range.
java.util.stream.Stream<Namespace>	findNamespacesStream(java.lang.String query) Get all namespaces that match a string in their name or path as a Stream.
Namespace	getNamespace(java.lang.Object namespaceIdOrPath) Get all details of a namespace.
java.util.List<Namespace>	getNamespaces() Get a list of the namespaces of the authenticated user.
Pager<Namespace>	getNamespaces(int itemsPerPage) Get a Pager of the namespaces of the authenticated user.
java.util.List<Namespace>	getNamespaces(int page, int perPage) Get a list of the namespaces of the authenticated user.
java.util.stream.Stream<Namespace>	getNamespacesStream() Get a Stream of the namespaces of the authenticated user.
java.util.Optional<Namespace>	getOptionalNamespace(java.lang.Object namespaceIdOrPath) Get all details of a namespace as an Optional instance.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getNamespaceIdOrPath, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceApi

public NamespaceApi(GitLabApi gitLabApi)

Method Detail

getNamespaces

public java.util.List<Namespace> getNamespaces()
                                        throws GitLabApiException

Get a list of the namespaces of the authenticated user. If the user is an administrator, a list of all namespaces in the GitLab instance is created.

GitLab Endpoint: GET /namespaces

Returns:

a List of Namespace instances

Throws:

GitLabApiException - if any exception occurs

getNamespaces

public java.util.List<Namespace> getNamespaces(int page,
                                               int perPage)
                                        throws GitLabApiException

Get a list of the namespaces of the authenticated user. If the user is an administrator, a list of all namespaces in the GitLab instance is returned.

GitLab Endpoint: GET /namespaces

Parameters:

page - the page to get

perPage - the number of Namespace instances per page

Returns:

a List of Namespace instances in the specified page range

Throws:

GitLabApiException - if any exception occurs

getNamespaces

public Pager<Namespace> getNamespaces(int itemsPerPage)
                               throws GitLabApiException

Get a Pager of the namespaces of the authenticated user. If the user is an administrator, a Pager of all namespaces in the GitLab instance is returned.

GitLab Endpoint: GET /namespaces

Parameters:

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager of Namespace instances

Throws:

GitLabApiException - if any exception occurs

getNamespacesStream

public java.util.stream.Stream<Namespace> getNamespacesStream()
                                                       throws GitLabApiException

Get a Stream of the namespaces of the authenticated user. If the user is an administrator, a Stream of all namespaces in the GitLab instance is returned.

GitLab Endpoint: GET /namespaces

Returns:

a Stream of Namespace instances

Throws:

GitLabApiException - if any exception occurs

findNamespaces

public java.util.List<Namespace> findNamespaces(java.lang.String query)
                                         throws GitLabApiException

Get all namespaces that match a string in their name or path.

GitLab Endpoint: GET /namespaces?search=:query

Parameters:

query - the search string

Returns:

the Namespace List with the matching namespaces

Throws:

GitLabApiException - if any exception occurs

findNamespaces

public java.util.List<Namespace> findNamespaces(java.lang.String query,
                                                int page,
                                                int perPage)
                                         throws GitLabApiException

Get all namespaces that match a string in their name or path in the specified page range.

GitLab Endpoint: GET /namespaces?search=:query

Parameters:

query - the search string

page - the page to get

perPage - the number of Namespace instances per page

Returns:

the Namespace List with the matching namespaces

Throws:

GitLabApiException - if any exception occurs

findNamespaces

public Pager<Namespace> findNamespaces(java.lang.String query,
                                       int itemsPerPage)
                                throws GitLabApiException

Get a Pager of all namespaces that match a string in their name or path.

GitLab Endpoint: GET /namespaces?search=:query

Parameters:

query - the search string

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager of Namespace instances with the matching namespaces

Throws:

GitLabApiException - if any exception occurs

findNamespacesStream

public java.util.stream.Stream<Namespace> findNamespacesStream(java.lang.String query)
                                                        throws GitLabApiException

Get all namespaces that match a string in their name or path as a Stream.

GitLab Endpoint: GET /namespaces?search=:query

Parameters:

query - the search string

Returns:

a Stream with the matching namespaces

Throws:

GitLabApiException - if any exception occurs

getNamespace

public Namespace getNamespace(java.lang.Object namespaceIdOrPath)
                       throws GitLabApiException

Get all details of a namespace.

GitLab Endpoint: GET /namespaces/:id

Parameters:

namespaceIdOrPath - the namespace ID, path of the namespace, or a Namespace instance holding the namespace ID or path

Returns:

the Namespace instance for the specified path

Throws:

GitLabApiException - if any exception occurs

getOptionalNamespace

public java.util.Optional<Namespace> getOptionalNamespace(java.lang.Object namespaceIdOrPath)

Get all details of a namespace as an Optional instance.

GitLab Endpoint: GET /namespaces/:id

Parameters:

namespaceIdOrPath - the namespace ID, path of the namespace, or a Namespace instance holding the namespace ID or path

Returns:

the Group for the specified group path as an Optional instance