Package org.gitlab4j.api

Class SystemHooksApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.SystemHooksApi

All Implemented Interfaces:

Constants

public class SystemHooksApi
extends AbstractApi

This class implements the client side API for the GitLab System Hooks Keys API calls.

Nested Class Summary

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

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.Encoding, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, 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
SystemHooksApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
SystemHook	addSystemHook(String url, String token, Boolean pushEvents, Boolean tagPushEvents, Boolean enablSsslVerification)	Add a new system hook.
void	deleteSystemHook(Integer hookId)	Deletes a system hook.
void	deleteSystemHook(SystemHook hook)	Deletes a system hook.
List<SystemHook>	getSystemHooks()	Get a list of all system hooks.
Pager<SystemHook>	getSystemHooks(int itemsPerPage)	Get a Pager of all system hooks.
List<SystemHook>	getSystemHooks(int page, int perPage)	Get a list of all system hooks using the specified page and per page settings.
Stream<SystemHook>	getSystemHookStream()	Get a Stream of all system hooks.
void	testSystemHook(Integer hookId)	Test a system hook.
void	testSystemHook(SystemHook hook)	Test a system hook.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, post, post, post, post, post, put, put, putUpload, putUpload, putWithFormData, 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

SystemHooksApi

public SystemHooksApi(GitLabApi gitLabApi)

Method Detail

getSystemHooks

public List<SystemHook> getSystemHooks()
                                throws GitLabApiException

Get a list of all system hooks. This method requires admin access.

GitLab Endpoint: GET /hooks

Returns:

a list of SystemHookEvent

Throws:

GitLabApiException - if any exception occurs

getSystemHooks

public List<SystemHook> getSystemHooks(int page,
                                       int perPage)
                                throws GitLabApiException

Get a list of all system hooks using the specified page and per page settings. This method requires admin access.

GitLab Endpoint: GET /hooks

Parameters:

page - the page to get

perPage - the number of deploy keys per page

Returns:

the list of SystemHookEvent in the specified range

Throws:

GitLabApiException - if any exception occurs

getSystemHooks

public Pager<SystemHook> getSystemHooks(int itemsPerPage)
                                 throws GitLabApiException

Get a Pager of all system hooks. This method requires admin access.

GitLab Endpoint: GET /hooks

Parameters:

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

Returns:

a Pager of SystemHookEvent

Throws:

GitLabApiException - if any exception occurs

getSystemHookStream

public Stream<SystemHook> getSystemHookStream()
                                       throws GitLabApiException

Get a Stream of all system hooks. This method requires admin access.

GitLab Endpoint: GET /hooks

Returns:

a Stream of SystemHookEvent

Throws:

GitLabApiException - if any exception occurs

addSystemHook

public SystemHook addSystemHook(String url,
                                String token,
                                Boolean pushEvents,
                                Boolean tagPushEvents,
                                Boolean enablSsslVerification)
                         throws GitLabApiException

Add a new system hook. This method requires admin access.

GitLab Endpoint: POST /hooks

Parameters:

url - the hook URL, required

token - secret token to validate received payloads, optional

pushEvents - when true, the hook will fire on push events, optional

tagPushEvents - when true, the hook will fire on new tags being pushed, optional

enablSsslVerification - do SSL verification when triggering the hook, optional

Returns:

an SystemHookEvent instance with info on the added system hook

Throws:

GitLabApiException - if any exception occurs

deleteSystemHook

public void deleteSystemHook(SystemHook hook)
                      throws GitLabApiException

Deletes a system hook. This method requires admin access.

GitLab Endpoint: DELETE /hooks/:hook_id

Parameters:

hook - the SystemHook instance to delete

Throws:

GitLabApiException - if any exception occurs

deleteSystemHook

public void deleteSystemHook(Integer hookId)
                      throws GitLabApiException

Deletes a system hook. This method requires admin access.

GitLab Endpoint: DELETE /hooks/:hook_id

Parameters:

hookId - the ID of the system hook to delete

Throws:

GitLabApiException - if any exception occurs

testSystemHook

public void testSystemHook(SystemHook hook)
                    throws GitLabApiException

Test a system hook. This method requires admin access.

GitLab Endpoint: GET /hooks/:hook_id

Parameters:

hook - the SystemHookEvent instance to test

Throws:

GitLabApiException - if any exception occurs

testSystemHook

public void testSystemHook(Integer hookId)
                    throws GitLabApiException

Test a system hook. This method requires admin access.

GitLab Endpoint: GET /hooks/:hook_id

Parameters:

hookId - the ID of the system hook to test

Throws:

GitLabApiException - if any exception occurs