Package org.gitlab4j.api
Class SystemHooksApi
java.lang.Object
org.gitlab4j.api.AbstractApi
org.gitlab4j.api.SystemHooksApi
- All Implemented Interfaces:
Constants
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.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, 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.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, 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
-
Method Summary
Modifier and TypeMethodDescriptionaddSystemHook
(String url, String token, Boolean pushEvents, Boolean tagPushEvents, Boolean enableSslVerification) Add a new system hook.addSystemHook
(String url, String token, SystemHook systemHook) Add a new system hook.void
deleteSystemHook
(Long hookId) Deletes a system hook.void
deleteSystemHook
(SystemHook hook) Deletes a system hook.Get a list of all system hooks.getSystemHooks
(int itemsPerPage) Get a Pager of all system hooks.getSystemHooks
(int page, int perPage) Get a list of all system hooks using the specified page and per page settings.Get a Stream of all system hooks.void
testSystemHook
(Long 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, 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
-
Constructor Details
-
SystemHooksApi
-
-
Method Details
-
getSystemHooks
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
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 getperPage
- the number of deploy keys per page- Returns:
- the list of SystemHookEvent in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getSystemHooks
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
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 enableSslVerification) throws GitLabApiException Add a new system hook. This method requires admin access.GitLab Endpoint: POST /hooks
- Parameters:
url
- the hook URL, requiredtoken
- secret token to validate received payloads, optionalpushEvents
- when true, the hook will fire on push events, optionaltagPushEvents
- when true, the hook will fire on new tags being pushed, optionalenableSslVerification
- 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
-
addSystemHook
public SystemHook addSystemHook(String url, String token, SystemHook systemHook) throws GitLabApiException Add a new system hook. This method requires admin access.GitLab Endpoint: POST /hooks
- Parameters:
url
- the hook URL, requiredtoken
- secret token to validate received payloads, optionalsystemHook
- the systemHook to create- Returns:
- an SystemHookEvent instance with info on the added system hook
- Throws:
GitLabApiException
- if any exception occurs
-
deleteSystemHook
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
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
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
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
-