Package org.gitlab4j.api

Class ServicesApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.ServicesApi

All Implemented Interfaces:

Constants

public class ServicesApi
extends AbstractApi

Access for the services API. See GitLab documentation. It is quite restricted as you may not retrieve the API but only set or delete.

Nested Class Summary

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

Constants.ActionType, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	deleteGitLabCI(Integer projectId)	Deletes the gitlab-ci service.
void	deleteGitLabCI(Project project)	DELETE /projects/:id/services/gitlab-ci
void	deleteHipChat(Integer projectId)	Deletes the gitlab-ci service.
void	deleteHipChat(Project project)	Deletes the gitlab-ci service.
void	setGitLabCI(Integer projectId, String token, String projectCIUrl)	Activates the gitlab-ci service.
void	setGitLabCI(Project project, String token, String projectCIUrl)	Activates the gitlab-ci service.
void	setHipChat(Integer projectId, String token, String room, String server)	Activates HipChat notifications.
void	setHipChat(Project project, String token, String room, String server)	Activates HipChat notifications.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getPageQueryParams, getWithAccepts, handle, isApiVersion, post, post, post, post, put, put, putWithFormData, urlEncode, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicesApi

public ServicesApi(GitLabApi gitLabApi)

Method Detail

setGitLabCI

public void setGitLabCI(Integer projectId,
                        String token,
                        String projectCIUrl)
                 throws GitLabApiException

Activates the gitlab-ci service. PUT /projects/:id/services/gitlab-ci

Parameters:

projectId - id of the project

token - for authentication

projectCIUrl - URL of the GitLab-CI project

Throws:

GitLabApiException - if any exception occurs

setGitLabCI

public void setGitLabCI(Project project,
                        String token,
                        String projectCIUrl)
                 throws GitLabApiException

Activates the gitlab-ci service. PUT /projects/:id/services/gitlab-ci

Parameters:

project - the project

token - for authentication

projectCIUrl - URL of the GitLab-CI project

Throws:

GitLabApiException - if any exception occurs

deleteGitLabCI

public void deleteGitLabCI(Integer projectId)
                    throws GitLabApiException

Deletes the gitlab-ci service. DELETE /projects/:id/services/gitlab-ci

Parameters:

projectId - id of the project

Throws:

GitLabApiException - if any exception occurs

deleteGitLabCI

public void deleteGitLabCI(Project project)
                    throws GitLabApiException

DELETE /projects/:id/services/gitlab-ci

Parameters:

project - to delete

Throws:

GitLabApiException - if any exception occurs

setHipChat

public void setHipChat(Integer projectId,
                       String token,
                       String room,
                       String server)
                throws GitLabApiException

Activates HipChat notifications. PUT /projects/:id/services/hipchat

Parameters:

projectId - id of the project

token - for authentication

room - HipChat Room

server - HipChat Server URL

Throws:

GitLabApiException - if any exception occurs

setHipChat

public void setHipChat(Project project,
                       String token,
                       String room,
                       String server)
                throws GitLabApiException

Activates HipChat notifications. PUT /projects/:id/services/hipchat

Parameters:

project - the Project instance to activate Hipchat for

token - for authentication

room - HipChat Room

server - HipChat Server URL

Throws:

GitLabApiException - if any exception occurs

deleteHipChat

public void deleteHipChat(Integer projectId)
                   throws GitLabApiException

Deletes the gitlab-ci service. DELETE /projects/:id/services/hipchat

Parameters:

projectId - id of the project

Throws:

GitLabApiException - if any exception occurs

deleteHipChat

public void deleteHipChat(Project project)
                   throws GitLabApiException

Deletes the gitlab-ci service. DELETE /projects/:id/services/hipchat

Parameters:

project - the project

Throws:

GitLabApiException - if any exception occurs