Package org.gitlab4j.api

Class AuditEventApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.AuditEventApi

All Implemented Interfaces:

Constants

public class AuditEventApi
extends AbstractApi

This class implements the client side API for the GitLab Instance Audit Event API. See Audit Event API at GitLab for more information.

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

Constructors

Constructor	Description
AuditEventApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
AuditEvent	getAuditEvent(Long auditEventId)	Get a specific instance audit event.
List<AuditEvent>	getAuditEvents(Date created_after, Date created_before, String entityType, Long entityId)	Get a List of the group audit events viewable by Maintainer or an Owner of the group.
Pager<AuditEvent>	getAuditEvents(Date created_after, Date created_before, String entityType, Long entityId, int itemsPerPage)	Get a Pager of the group audit events viewable by Maintainer or an Owner of the group.
Stream<AuditEvent>	getAuditEventsStream(Date created_after, Date created_before, String entityType, Long entityId)	Get a Stream of the group audit events viewable by Maintainer or an Owner of the group.

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 Details

AuditEventApi

public AuditEventApi(GitLabApi gitLabApi)

Method Details

getAuditEvents

public List<AuditEvent> getAuditEvents(Date created_after,
 Date created_before,
 String entityType,
 Long entityId)
                                throws GitLabApiException

Get a List of the group audit events viewable by Maintainer or an Owner of the group.

GET /audit_events/

Parameters:

created_after - Return group audit events created on or after the given time.

created_before - Return group audit events created on or before the given time.

entityType - Return audit events for the given entity type. Valid values are: User, Group, or Project.

entityId - Return audit events for the given entity ID. Requires entityType attribute to be present.

Returns:

a List of group Audit events

Throws:

GitLabApiException - if any exception occurs

getAuditEvents

public Pager<AuditEvent> getAuditEvents(Date created_after,
 Date created_before,
 String entityType,
 Long entityId,
 int itemsPerPage)
                                 throws GitLabApiException

Get a Pager of the group audit events viewable by Maintainer or an Owner of the group.

GET /audit_events

Parameters:

created_after - Return group audit events created on or after the given time.

created_before - Return group audit events created on or before the given time.

entityType - Return audit events for the given entity type. Valid values are: User, Group, or Project.

entityId - Return audit events for the given entity ID. Requires entityType attribute to be present.

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

Returns:

a Pager of group Audit events

Throws:

GitLabApiException - if any exception occurs

getAuditEventsStream

public Stream<AuditEvent> getAuditEventsStream(Date created_after,
 Date created_before,
 String entityType,
 Long entityId)
                                        throws GitLabApiException

Get a Stream of the group audit events viewable by Maintainer or an Owner of the group.

GET /audit_events

Parameters:

created_after - Return group audit events created on or after the given time.

created_before - Return group audit events created on or before the given time.

entityType - Return audit events for the given entity type. Valid values are: User, Group, or Project.

entityId - Return audit events for the given entity ID. Requires entityType attribute to be present.

Returns:

a Stream of group Audit events

Throws:

GitLabApiException - if any exception occurs

getAuditEvent

public AuditEvent getAuditEvent(Long auditEventId)
                         throws GitLabApiException

Get a specific instance audit event.

GitLab Endpoint: GET /audit_events/:id

Parameters:

auditEventId - the auditEventId, required

Returns:

the group Audit event

Throws:

GitLabApiException - if any exception occurs