Package org.gitlab4j.api

Class SearchApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.SearchApi

All Implemented Interfaces:

Constants

public class SearchApi
extends AbstractApi

This class provides an entry point to all the GitLab API Search API calls.

See Also:

Search API

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.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	Description
SearchApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
java.util.List<?>	globalSearch(Constants.SearchScope scope, java.lang.String search)	Search globally across the GitLab instance.
Pager<?>	globalSearch(Constants.SearchScope scope, java.lang.String search, int itemsPerPage)	Search globally across the GitLab instance.
java.util.stream.Stream<?>	globalSearchStream(Constants.SearchScope scope, java.lang.String search)	Search globally across the GitLab instance.
java.util.List<?>	groupSearch(java.lang.Object groupIdOrPath, Constants.GroupSearchScope scope, java.lang.String search)	Search within the specified group.
Pager<?>	groupSearch(java.lang.Object groupIdOrPath, Constants.GroupSearchScope scope, java.lang.String search, int itemsPerPage)	Search within the specified group.
java.util.stream.Stream<?>	groupSearchStream(java.lang.Object groupIdOrPath, Constants.GroupSearchScope scope, java.lang.String search)	Search within the specified group.
java.util.List<?>	projectSearch(java.lang.Object projectIdOrPath, Constants.ProjectSearchScope scope, java.lang.String search)	Search within the specified project.
Pager<?>	projectSearch(java.lang.Object projectIdOrPath, Constants.ProjectSearchScope scope, java.lang.String search, int itemsPerPage)	Search within the specified project.
java.util.List<?>	projectSearch(java.lang.Object projectIdOrPath, Constants.ProjectSearchScope scope, java.lang.String search, java.lang.String ref)	Search within the specified project.
Pager<?>	projectSearch(java.lang.Object projectIdOrPath, Constants.ProjectSearchScope scope, java.lang.String search, java.lang.String ref, int itemsPerPage)	Search within the specified project.
java.util.stream.Stream<?>	projectSearchStream(java.lang.Object projectIdOrPath, Constants.ProjectSearchScope scope, java.lang.String search)	Search within the specified project.
java.util.stream.Stream<?>	projectSearchStream(java.lang.Object projectIdOrPath, Constants.ProjectSearchScope scope, java.lang.String search, java.lang.String ref)	Search within the specified project.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, 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

SearchApi

public SearchApi(GitLabApi gitLabApi)

Method Detail

globalSearch

public java.util.List<?> globalSearch(Constants.SearchScope scope,
                                      java.lang.String search)
                               throws GitLabApiException

Search globally across the GitLab instance.

GitLab Endpoint: POST /search?scope=:scope&search=:search-query

Parameters:

scope - search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs, users

search - the search query

Returns:

a List containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

globalSearchStream

public java.util.stream.Stream<?> globalSearchStream(Constants.SearchScope scope,
                                                     java.lang.String search)
                                              throws GitLabApiException

Search globally across the GitLab instance.

GitLab Endpoint: POST /search?scope=:scope&search=:search-query

Parameters:

scope - search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs, users

search - the search query

Returns:

a Stream containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

globalSearch

public Pager<?> globalSearch(Constants.SearchScope scope,
                             java.lang.String search,
                             int itemsPerPage)
                      throws GitLabApiException

Search globally across the GitLab instance.

GitLab Endpoint: POST /search?scope=:scope&search=:search-query

Parameters:

scope - search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs, users

search - the search query

itemsPerPage - the number of items that will be fetched per page

Returns:

a Pager containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

groupSearch

public java.util.List<?> groupSearch(java.lang.Object groupIdOrPath,
                                     Constants.GroupSearchScope scope,
                                     java.lang.String search)
                              throws GitLabApiException

Search within the specified group. If a user is not a member of a group and the group is private, a request on that group will result to a 404 status code.

GitLab Endpoint: POST /groups/:groupId/search?scope=:scope&search=:search-query

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path, required

scope - search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, users

search - the search query

Returns:

a List containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

groupSearchStream

public java.util.stream.Stream<?> groupSearchStream(java.lang.Object groupIdOrPath,
                                                    Constants.GroupSearchScope scope,
                                                    java.lang.String search)
                                             throws GitLabApiException

Search within the specified group. If a user is not a member of a group and the group is private, a request on that group will result to a 404 status code.

GitLab Endpoint: POST /groups/:groupId/search?scope=:scope&search=:search-query

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path, required

scope - search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, users

search - the search query

Returns:

a Stream containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

groupSearch

public Pager<?> groupSearch(java.lang.Object groupIdOrPath,
                            Constants.GroupSearchScope scope,
                            java.lang.String search,
                            int itemsPerPage)
                     throws GitLabApiException

Search within the specified group. If a user is not a member of a group and the group is private, a request on that group will result to a 404 status code.

GitLab Endpoint: POST /groups/:groupId/search?scope=:scope&search=:search-query

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path, required

scope - search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, users

search - the search query

itemsPerPage - the number of items that will be fetched per page

Returns:

a Pager containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

projectSearch

public java.util.List<?> projectSearch(java.lang.Object projectIdOrPath,
                                       Constants.ProjectSearchScope scope,
                                       java.lang.String search)
                                throws GitLabApiException

Search within the specified project. If a user is not a member of a project and the project is private, a request on that project will result to a 404 status code.

GitLab Endpoint: POST /projects/:projectId/search?scope=:scope&search=:search-query

Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance, required

scope - search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users

search - the search query

Returns:

a List containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

projectSearch

public java.util.List<?> projectSearch(java.lang.Object projectIdOrPath,
                                       Constants.ProjectSearchScope scope,
                                       java.lang.String search,
                                       java.lang.String ref)
                                throws GitLabApiException

Search within the specified project. If a user is not a member of a project and the project is private, a request on that project will result to a 404 status code.

GitLab Endpoint: POST /projects/:projectId/search?scope=:scope&search=:search-query&ref=ref

Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance, required

scope - search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users

search - the search query

ref - the name of a repository branch or tag to search on. The project’s default branch is used by default. This is only applicable for scopes: commits, blobs, and wiki_blobs.

Returns:

a List containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

projectSearchStream

public java.util.stream.Stream<?> projectSearchStream(java.lang.Object projectIdOrPath,
                                                      Constants.ProjectSearchScope scope,
                                                      java.lang.String search)
                                               throws GitLabApiException

Search within the specified project. If a user is not a member of a project and the project is private, a request on that project will result to a 404 status code.

GitLab Endpoint: POST /projects/:projectId/search?scope=:scope&search=:search-query

Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance, required

scope - search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users

search - the search query

Returns:

a Stream containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

projectSearchStream

public java.util.stream.Stream<?> projectSearchStream(java.lang.Object projectIdOrPath,
                                                      Constants.ProjectSearchScope scope,
                                                      java.lang.String search,
                                                      java.lang.String ref)
                                               throws GitLabApiException

Search within the specified project. If a user is not a member of a project and the project is private, a request on that project will result to a 404 status code.

GitLab Endpoint: POST /projects/:projectId/search?scope=:scope&search=:search-query&ref=ref

Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance, required

scope - search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users

search - the search query

ref - the name of a repository branch or tag to search on. The project’s default branch is used by default. This is only applicable for scopes: commits, blobs, and wiki_blobs.

Returns:

a Stream containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

projectSearch

public Pager<?> projectSearch(java.lang.Object projectIdOrPath,
                              Constants.ProjectSearchScope scope,
                              java.lang.String search,
                              int itemsPerPage)
                       throws GitLabApiException

Search within the specified project. If a user is not a member of a project and the project is private, a request on that project will result to a 404 status code.

GitLab Endpoint: POST /project/:projectId/search?scope=:scope&search=:search-query

Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance, required

scope - search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users

search - the search query

itemsPerPage - the number of items that will be fetched per page

Returns:

a Pager containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5

projectSearch

public Pager<?> projectSearch(java.lang.Object projectIdOrPath,
                              Constants.ProjectSearchScope scope,
                              java.lang.String search,
                              java.lang.String ref,
                              int itemsPerPage)
                       throws GitLabApiException

Search within the specified project. If a user is not a member of a project and the project is private, a request on that project will result to a 404 status code.

GitLab Endpoint: POST /project/:projectId/search?scope=:scope&search=:search-query&ref=ref

Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance, required

scope - search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users

search - the search query

ref - the name of a repository branch or tag to search on. The project’s default branch is used by default. This is only applicable for scopes: commits, blobs, and wiki_blobs.

itemsPerPage - the number of items that will be fetched per page

Returns:

a Pager containing the object type specified by the scope

Throws:

GitLabApiException - if any exception occurs

Since:

GitLab 10.5