Package org.gitlab4j.api

Class TopicsApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.TopicsApi

All Implemented Interfaces:

Constants

public class TopicsApi
extends AbstractApi

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
TopicsApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Topic	createTopic(TopicParams params)	Creates a new Topic.
void	deleteTopic(java.lang.Integer id)	Delete a topic.
Topic	deleteTopicAvatar(java.lang.Integer id)	Delete the topic's avatar for the specified topic.
java.util.Optional<Topic>	getOptionalTopic(java.lang.Integer id)	Get all details of a topic as an Optional instance.
Topic	getTopic(java.lang.Integer id)	Get all details of a topic.
java.util.List<Topic>	getTopics()	Get a list of Topics.
Pager<Topic>	getTopics(int itemsPerPage)	Get a Pager of topics.
java.util.List<Topic>	getTopics(int page, int perPage)	Get a list of topics in the specified page range.
java.util.stream.Stream<Topic>	getTopicsStream()	Get a Stream of topics.
Topic	mergeTopics(java.lang.Integer sourceTopicId, java.lang.Integer targetTopicId)	Merge two topics together.
Topic	updateTopic(java.lang.Integer id, TopicParams params)	Update a project topic.
Topic	updateTopicAvatar(java.lang.Integer id, java.io.File avatarFile)	Uploads and sets the topic's avatar for the specified topic.

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

TopicsApi

public TopicsApi(GitLabApi gitLabApi)

Method Detail

getTopics

public java.util.List<Topic> getTopics()
                                throws GitLabApiException

Get a list of Topics.

WARNING: Do not use this method to fetch Topics from https://gitlab.com, gitlab.com has many 1,000's of public topics and it will a long time to fetch all of them. Instead use getTopics(int itemsPerPage) which will return a Pager of Topic instances.

GitLab Endpoint: GET /topics

Returns:

the list of topics viewable by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getTopics

public java.util.List<Topic> getTopics(int page,
                                       int perPage)
                                throws GitLabApiException

Get a list of topics in the specified page range.

GitLab Endpoint: GET /topics

Parameters:

page - the page to get

perPage - the number of Topic instances per page

Returns:

the list of topics

Throws:

GitLabApiException - if any exception occurs

getTopics

public Pager<Topic> getTopics(int itemsPerPage)
                       throws GitLabApiException

Get a Pager of topics.

GitLab Endpoint: GET /topics

Parameters:

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

Returns:

the pager of topics

Throws:

GitLabApiException - if any exception occurs

getTopicsStream

public java.util.stream.Stream<Topic> getTopicsStream()
                                               throws GitLabApiException

Get a Stream of topics.

GitLab Endpoint: GET /topics

Returns:

the stream of topics

Throws:

GitLabApiException - if any exception occurs

getTopic

public Topic getTopic(java.lang.Integer id)
               throws GitLabApiException

Get all details of a topic.

GitLab Endpoint: GET /topics/:id

Parameters:

id - the topic ID

Returns:

the topic for the specified topic id

Throws:

GitLabApiException - if any exception occurs

getOptionalTopic

public java.util.Optional<Topic> getOptionalTopic(java.lang.Integer id)

Get all details of a topic as an Optional instance.

GitLab Endpoint: GET /topics/:id

Parameters:

id - the topic ID

Returns:

the Topic for the specified topic id as an Optional instance

createTopic

public Topic createTopic(TopicParams params)
                  throws GitLabApiException

Creates a new Topic. Available only for users who can create topics.

GitLab Endpoint: POST /topics

Parameters:

params - a TopicParams instance holding the parameters for the topic creation

Returns:

the created Topic instance

Throws:

GitLabApiException - if any exception occurs

updateTopic

public Topic updateTopic(java.lang.Integer id,
                         TopicParams params)
                  throws GitLabApiException

Update a project topic.

GitLab Endpoint: PUT /topics/:id

Parameters:

id - the topic id

params - a TopicParams instance holding the properties to Update

Returns:

the updated Topic instance

Throws:

GitLabApiException - at any exception

updateTopicAvatar

public Topic updateTopicAvatar(java.lang.Integer id,
                               java.io.File avatarFile)
                        throws GitLabApiException

Uploads and sets the topic's avatar for the specified topic.

GitLab Endpoint: PUT /topics/:id

Parameters:

id - the topic in the form of an Integer

avatarFile - the File instance of the avatar file to upload

Returns:

the updated Topic instance

Throws:

GitLabApiException - if any exception occurs

deleteTopicAvatar

public Topic deleteTopicAvatar(java.lang.Integer id)
                        throws GitLabApiException

Delete the topic's avatar for the specified topic.

GitLab Endpoint: PUT /topics/:id

Parameters:

id - the topic in the form of an Integer

Returns:

the updated Topic instance

Throws:

GitLabApiException - if any exception occurs

deleteTopic

public void deleteTopic(java.lang.Integer id)
                 throws GitLabApiException

Delete a topic. You must be an administrator to delete a project topic. When you delete a project topic, you also delete the topic assignment for projects.

GitLab Endpoint: DELETE /topics/:id

Parameters:

id - the topic to deleted in the form of an Integer

Throws:

GitLabApiException - if any exception occurs

mergeTopics

public Topic mergeTopics(java.lang.Integer sourceTopicId,
                         java.lang.Integer targetTopicId)
                  throws GitLabApiException

Merge two topics together. You must be an administrator to merge a source topic into a target topic. When you merge topics, you delete the source topic and move all assigned projects to the target topic.

GitLab Endpoint: POST /topics/merge

Parameters:

sourceTopicId - ID of source project topic

targetTopicId - ID of target project topic

Returns:

the merged Topic instance

Throws:

GitLabApiException - if any exception occurs