EventsApi (gitlab4j-api 5.5.0 API)

java.lang.Object
- org.gitlab4j.api.AbstractApi
- - org.gitlab4j.api.EventsApi

All Implemented Interfaces:

Constants
```
public class EventsApi
extends AbstractApi
```
This class implements the client side API for the GitLab events 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.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 and Description

EventsApi(GitLabApi gitLabApi)

Constructors
Constructor and Description
`EventsApi(GitLabApi gitLabApi)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<Event>`	`getAllAuthenticatedUserEvents(Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder)` Get a list of all events for the authenticated user, across all of the user's projects.
`java.util.stream.Stream<Event>`	`getAllAuthenticatedUserEventsStream(Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder)` Get a Stream of all events for the authenticated user, across all of the user's projects.
`java.util.List<Event>`	`getAuthenticatedUserEvents(Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder)` Get a list of events for the authenticated user.
`Pager<Event>`	`getAuthenticatedUserEvents(Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder, int itemsPerPage)` Get a list of events for the authenticated user and in the specified page range.
`Pager<Event>`	`getAuthenticatedUserEvents(Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder, int itemsPerPage, Constants.EventScope scope)` Get a list of events for the authenticated user and in the specified page range.
`java.util.List<Event>`	`getAuthenticatedUserEvents(Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder, int page, int perPage)` Get a list of events for the authenticated user and in the specified page range.
`java.util.List<Event>`	`getAuthenticatedUserEvents(Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder, int page, int perPage, Constants.EventScope scope)` Get a list of events for the authenticated user and in the specified page range.
`java.util.stream.Stream<Event>`	`getAuthenticatedUserEventsStream(Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder)` Get a Stream of events for the authenticated user.
`java.util.List<Event>`	`getProjectEvents(java.lang.Object projectIdOrPath, Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder)` Get a list of events for the specified project.
`Pager<Event>`	`getProjectEvents(java.lang.Object projectIdOrPath, Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder, int itemsPerPage)` Get a list of events for the specified project and in the specified page range.
`java.util.List<Event>`	`getProjectEvents(java.lang.Object projectIdOrPath, Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder, int page, int perPage)` Get a list of events for the specified project and in the specified page range.
`java.util.stream.Stream<Event>`	`getProjectEventsStream(java.lang.Object projectIdOrPath, Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder)` Get a Stream of events for the specified project.
`java.util.List<Event>`	`getUserEvents(java.lang.Object userIdOrUsername, Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder)` Get a list of events for the specified user.
`Pager<Event>`	`getUserEvents(java.lang.Object userIdOrUsername, Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder, int itemsPerPage)` Get a list of events for the specified user and in the specified page range.
`java.util.List<Event>`	`getUserEvents(java.lang.Object userIdOrUsername, Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder, int page, int perPage)` Get a list of events for the specified user and in the specified page range.
`java.util.stream.Stream<Event>`	`getUserEventsStream(java.lang.Object userIdOrUsername, Constants.ActionType action, Constants.TargetType targetType, java.util.Date before, java.util.Date after, Constants.SortOrder sortOrder)` Get a Stream of events for the specified user.

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 Detail
- EventsApi
```
public EventsApi(GitLabApi gitLabApi)
```

Method Detail

getAuthenticatedUserEvents

public java.util.List<Event> getAuthenticatedUserEvents(Constants.ActionType action,
                                                        Constants.TargetType targetType,
                                                        java.util.Date before,
                                                        java.util.Date after,
                                                        Constants.SortOrder sortOrder)
                                                 throws GitLabApiException

Get a list of events for the authenticated user.

GitLab Endpoint: GET /events

Parameters:: action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional
Returns:: a list of events for the authenticated user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getAllAuthenticatedUserEvents

public java.util.List<Event> getAllAuthenticatedUserEvents(Constants.ActionType action,
                                                           Constants.TargetType targetType,
                                                           java.util.Date before,
                                                           java.util.Date after,
                                                           Constants.SortOrder sortOrder)
                                                    throws GitLabApiException

Get a list of all events for the authenticated user, across all of the user's projects.

GitLab Endpoint: GET /events

Parameters:: action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional
Returns:: a list of events for the authenticated user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getAuthenticatedUserEvents

public java.util.List<Event> getAuthenticatedUserEvents(Constants.ActionType action,
                                                        Constants.TargetType targetType,
                                                        java.util.Date before,
                                                        java.util.Date after,
                                                        Constants.SortOrder sortOrder,
                                                        int page,
                                                        int perPage)
                                                 throws GitLabApiException

Get a list of events for the authenticated user and in the specified page range.

GitLab Endpoint: GET /events

Parameters:: action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional; page - the page to get; perPage - the number of projects per page
Returns:: a list of events for the authenticated user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getAuthenticatedUserEvents

public java.util.List<Event> getAuthenticatedUserEvents(Constants.ActionType action,
                                                        Constants.TargetType targetType,
                                                        java.util.Date before,
                                                        java.util.Date after,
                                                        Constants.SortOrder sortOrder,
                                                        int page,
                                                        int perPage,
                                                        Constants.EventScope scope)
                                                 throws GitLabApiException

Get a list of events for the authenticated user and in the specified page range.

GitLab Endpoint: GET /events

Parameters:: action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional; page - the page to get; perPage - the number of projects per page; scope - include all events across a user’s projects, optional
Returns:: a list of events for the authenticated user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getAuthenticatedUserEvents
```
public Pager<Event> getAuthenticatedUserEvents(Constants.ActionType action,
                                               Constants.TargetType targetType,
                                               java.util.Date before,
                                               java.util.Date after,
                                               Constants.SortOrder sortOrder,
                                               int itemsPerPage)
                                        throws GitLabApiException
```
Get a list of events for the authenticated user and in the specified page range.
```
GitLab Endpoint: GET /events
```
Parameters:

action - include only events of a particular action type, optional

targetType - include only events of a particular target type, optional

before - include only events created before a particular date, optional

after - include only events created after a particular date, optional

sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional

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

Returns:

a Pager of events for the authenticated user and matching the supplied parameters

Throws:

GitLabApiException - if any exception occurs

getAuthenticatedUserEvents

public Pager<Event> getAuthenticatedUserEvents(Constants.ActionType action,
                                               Constants.TargetType targetType,
                                               java.util.Date before,
                                               java.util.Date after,
                                               Constants.SortOrder sortOrder,
                                               int itemsPerPage,
                                               Constants.EventScope scope)
                                        throws GitLabApiException

Get a list of events for the authenticated user and in the specified page range.

GitLab Endpoint: GET /events

Parameters:: action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional; itemsPerPage - the number of Event instances that will be fetched per page; scope - include all events across a user’s projects, optional
Returns:: a Pager of events for the authenticated user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getAuthenticatedUserEventsStream

public java.util.stream.Stream<Event> getAuthenticatedUserEventsStream(Constants.ActionType action,
                                                                       Constants.TargetType targetType,
                                                                       java.util.Date before,
                                                                       java.util.Date after,
                                                                       Constants.SortOrder sortOrder)
                                                                throws GitLabApiException

Get a Stream of events for the authenticated user.

GitLab Endpoint: GET /events

Parameters:: action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional
Returns:: a Stream of events for the authenticated user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getAllAuthenticatedUserEventsStream

public java.util.stream.Stream<Event> getAllAuthenticatedUserEventsStream(Constants.ActionType action,
                                                                          Constants.TargetType targetType,
                                                                          java.util.Date before,
                                                                          java.util.Date after,
                                                                          Constants.SortOrder sortOrder)
                                                                   throws GitLabApiException

Get a Stream of all events for the authenticated user, across all of the user's projects.

GitLab Endpoint: GET /events

Parameters:: action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional
Returns:: a Stream of events for the authenticated user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getUserEvents

public java.util.List<Event> getUserEvents(java.lang.Object userIdOrUsername,
                                           Constants.ActionType action,
                                           Constants.TargetType targetType,
                                           java.util.Date before,
                                           java.util.Date after,
                                           Constants.SortOrder sortOrder)
                                    throws GitLabApiException

Get a list of events for the specified user.

GitLab Endpoint: GET /users/:userId/events

Parameters:: userIdOrUsername - the user ID, username of the user, or a User instance holding the user ID or username; action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional
Returns:: a list of events for the specified user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getUserEvents

public java.util.List<Event> getUserEvents(java.lang.Object userIdOrUsername,
                                           Constants.ActionType action,
                                           Constants.TargetType targetType,
                                           java.util.Date before,
                                           java.util.Date after,
                                           Constants.SortOrder sortOrder,
                                           int page,
                                           int perPage)
                                    throws GitLabApiException

Get a list of events for the specified user and in the specified page range.

GitLab Endpoint: GET /users/:userId/events

Parameters:: userIdOrUsername - the user ID, username of the user, or a User instance holding the user ID or username; action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional; page - the page to get; perPage - the number of projects per page
Returns:: a list of events for the specified user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getUserEvents
```
public Pager<Event> getUserEvents(java.lang.Object userIdOrUsername,
                                  Constants.ActionType action,
                                  Constants.TargetType targetType,
                                  java.util.Date before,
                                  java.util.Date after,
                                  Constants.SortOrder sortOrder,
                                  int itemsPerPage)
                           throws GitLabApiException
```
Get a list of events for the specified user and in the specified page range.
```
GitLab Endpoint: GET /users/:userId/events
```
Parameters:

userIdOrUsername - the user ID, username of the user, or a User instance holding the user ID or username

action - include only events of a particular action type, optional

targetType - include only events of a particular target type, optional

before - include only events created before a particular date, optional

after - include only events created after a particular date, optional

sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional

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

Returns:

a Pager of events for the specified user and matching the supplied parameters

Throws:

GitLabApiException - if any exception occurs

getUserEventsStream

public java.util.stream.Stream<Event> getUserEventsStream(java.lang.Object userIdOrUsername,
                                                          Constants.ActionType action,
                                                          Constants.TargetType targetType,
                                                          java.util.Date before,
                                                          java.util.Date after,
                                                          Constants.SortOrder sortOrder)
                                                   throws GitLabApiException

Get a Stream of events for the specified user.

GitLab Endpoint: GET /users/:userId/events

Parameters:: userIdOrUsername - the user ID, username of the user, or a User instance holding the user ID or username; action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional
Returns:: a Stream of events for the specified user and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getProjectEvents

public java.util.List<Event> getProjectEvents(java.lang.Object projectIdOrPath,
                                              Constants.ActionType action,
                                              Constants.TargetType targetType,
                                              java.util.Date before,
                                              java.util.Date after,
                                              Constants.SortOrder sortOrder)
                                       throws GitLabApiException

Get a list of events for the specified project.

GitLab Endpoint: GET /:projectId/events

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional
Returns:: a list of events for the specified project and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getProjectEvents

public java.util.List<Event> getProjectEvents(java.lang.Object projectIdOrPath,
                                              Constants.ActionType action,
                                              Constants.TargetType targetType,
                                              java.util.Date before,
                                              java.util.Date after,
                                              Constants.SortOrder sortOrder,
                                              int page,
                                              int perPage)
                                       throws GitLabApiException

Get a list of events for the specified project and in the specified page range.

GitLab Endpoint: GET /projects/:projectId/events

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional; page - the page to get; perPage - the number of projects per page
Returns:: a list of events for the specified project and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

getProjectEvents
```
public Pager<Event> getProjectEvents(java.lang.Object projectIdOrPath,
                                     Constants.ActionType action,
                                     Constants.TargetType targetType,
                                     java.util.Date before,
                                     java.util.Date after,
                                     Constants.SortOrder sortOrder,
                                     int itemsPerPage)
                              throws GitLabApiException
```
Get a list of events for the specified project and in the specified page range.
```
GitLab Endpoint: GET /projects/:projectId/events
```
Parameters:

projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance

action - include only events of a particular action type, optional

targetType - include only events of a particular target type, optional

before - include only events created before a particular date, optional

after - include only events created after a particular date, optional

sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional

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

Returns:

a Pager of events for the specified project and matching the supplied parameters

Throws:

GitLabApiException - if any exception occurs

getProjectEventsStream

public java.util.stream.Stream<Event> getProjectEventsStream(java.lang.Object projectIdOrPath,
                                                             Constants.ActionType action,
                                                             Constants.TargetType targetType,
                                                             java.util.Date before,
                                                             java.util.Date after,
                                                             Constants.SortOrder sortOrder)
                                                      throws GitLabApiException

Get a Stream of events for the specified project.

GitLab Endpoint: GET /:projectId/events

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; action - include only events of a particular action type, optional; targetType - include only events of a particular target type, optional; before - include only events created before a particular date, optional; after - include only events created after a particular date, optional; sortOrder - sort events in ASC or DESC order by created_at. Default is DESC, optional
Returns:: a Stream of events for the specified project and matching the supplied parameters
Throws:: GitLabApiException - if any exception occurs

Class EventsApi

Nested Class Summary

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

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

Fields inherited from interface org.gitlab4j.api.Constants

Constructor Summary

Method Summary

Methods inherited from class org.gitlab4j.api.AbstractApi

Methods inherited from class java.lang.Object

Constructor Detail

EventsApi

Method Detail

getAuthenticatedUserEvents

getAllAuthenticatedUserEvents

getAuthenticatedUserEvents

getAuthenticatedUserEvents

getAuthenticatedUserEvents

getAuthenticatedUserEvents

getAuthenticatedUserEventsStream

getAllAuthenticatedUserEventsStream

getUserEvents

getUserEvents

getUserEvents

getUserEventsStream

getProjectEvents

getProjectEvents

getProjectEvents

getProjectEventsStream