Package org.gitlab4j.api

Interface Summary

Interface	Description
Constants
HookManager	This interface provides a base class handler for processing GitLab Web Hook and System Hook callouts.

Class Summary

Class	Description
AbstractApi	This class is the base class for all the sub API classes.
ApplicationsApi	This class implements the client side API for the GitLab Applications API.
ApplicationSettingsApi	This class implements the client side API for the GitLab Application Settings API.
AuditEventApi	This class implements the client side API for the GitLab Instance Audit Event API.
AwardEmojiApi	This class implements the client side API for the GitLab Award Emoji API calls.
BoardsApi	This class implements the client side API for the GitLab Issue Boards API calls.
CommitsApi	This class implements the client side API for the GitLab commits calls.
ContainerRegistryApi	This class implements the client side API for the GitLab Container Registry API.
DeployKeysApi	This class implements the client side API for the GitLab Deploy Keys API calls.
DeploymentsApi	This class implements the client side API for the GitLab Deployments API calls.
DeployTokensApi	This class implements the client side API for the GitLab Deploy Tokens API calls.
DiscussionsApi	This class implements the client side API for the GitLab Discussions API.
EnvironmentsApi	This class provides an entry point to all the GitLab API Environments API calls.
EpicsApi	This class implements the client side API for the GitLab Epics and Epic Issues API calls.
EventsApi	This class implements the client side API for the GitLab events calls.
ExternalStatusCheckApi	This class implements the client side API for the GitLab external status checks.
GitLabApi	This class is provides a simplified interface to a GitLab API server, and divides the API up into a separate API class for each concern.
GitLabApiClient	This class utilizes the Jersey client package to communicate with a GitLab API endpoint.
GitLabApiForm	This class extends the standard JAX-RS Form class to make it fluent.
GitLabCiYamlApi	This class provides an entry point to all the GitLab CI YAML API calls.
GroupApi	This class implements the client side API for the GitLab groups calls.
HealthCheckApi
ImportExportApi	This class provides an entry point to all the GitLab API project import/export calls.
IssuesApi	This class provides an entry point to all the GitLab API Issue calls.
JobApi	This class provides an entry point to all the GitLab API job calls.
KeysApi	See: https://docs.gitlab.com/ee/api/keys.html#get-user-by-fingerprint-of-ssh-key
LabelsApi	This class provides an entry point to all the GitLab API project and group label calls.
LicenseApi	This class provides an entry point to all the GitLab API license calls.
LicenseTemplatesApi	This class provides an entry point to all the GitLab API licenses calls.
MarkdownApi	This class provides an entry point to all the GitLab API markdown calls.
MergeRequestApi	This class implements the client side API for the GitLab merge request calls.
MetadataApi	This class implements the client side API for the Gitlab metadata call.
MilestonesApi	This class implements the client side API for the GitLab milestones calls.
NamespaceApi	This class implements the client side API for the GitLab namespace calls.
NotesApi
NotificationSettingsApi
PackagesApi	This class implements the client side API for the GitLab Packages API.
Pager<T>	This class defines an Iterator implementation that is used as a paging iterator for all API methods that return a List of objects.
PipelineApi	This class provides an entry point to all the GitLab API pipeline related calls.
ProjectApi	This class provides an entry point to all the GitLab API project calls.
ProjectLicense
ProtectedBranchesApi	This class provides an entry point to all the Protected Branches API calls.
ProxyClientConfig	This class provides convenience methods to create ClientConfig properties so GitLabApi can use a proxy server.
ReleaseLinksApi	This class provides an entry point to all the GitLab ReleaseLinks API calls.
ReleasesApi	This class provides an entry point to all the GitLab Releases API calls.
RepositoryApi	This class provides an entry point to all the GitLab API repository calls.
RepositoryFileApi	This class provides an entry point to all the GitLab API repository files calls.
RepositorySubmodulesApi	This class provides an entry point to all the GitLab API repository submodules calls.
ResourceLabelEventsApi	This class provides an entry point to all the GitLab Resource label events API
ResourceStateEventsApi	This class provides an entry point to all the GitLab Resource state events API
RunnersApi	This class provides an entry point to all the GitLab API repository files calls.
SearchApi	This class provides an entry point to all the GitLab API Search API calls.
ServicesApi	Access for the services API.
SnippetsApi	This class provides an entry point to all the GitLab Snippets API project calls.
SystemHooksApi	This class implements the client side API for the GitLab System Hooks Keys API calls.
TagsApi	This class provides an entry point to all the GitLab Tags and Protected Tags API calls.
TodosApi	This class implements the client side API for the GitLab Todos API.
TopicsApi
UserApi	This class provides an entry point to all the GitLab API users calls.
WikisApi	This class implements the client side API for the GitLab Wikis API.

Enum Summary

Enum	Description
Constants.ActionType	Enum to use for specifying the event action_type.
Constants.ApplicationScope	Enum for the various Application scope values.
Constants.ArchiveFormat	Enum to specify the format of a downloaded archive.
Constants.AutoDevopsDeployStrategy
Constants.BuildGitStrategy	Enum for the build_git_strategy of the project instance.
Constants.CommitBuildState	Enum for the various Commit build status values.
Constants.ContributorOrderBy	Enum to use for ordering the results of getContibutors().
Constants.DefaultBranchProtectionLevel
Constants.DeploymentOrderBy	Enum to use for ordering the results of getDeployments.
Constants.DeploymentStatus	Enum to use for specifying the status of a deployment.
Constants.DeployTokenScope	Enum to use for specifying the deploy token scope.
Constants.Encoding	Enum to specify encoding of file contents.
Constants.EpicOrderBy	Enum to use for ordering the results of getEpics().
Constants.EventScope	Enum to use for specifying the Event scope.
Constants.GroupOrderBy	Enum to use for ordering the results of getGroups() and getSubGroups().
Constants.GroupSearchScope	Enum for the search scope when doing a groupSearch() with the SearchApi.
Constants.ImpersonationState	Enum to specify the state of an ImpersonationToken.
Constants.IssueOrderBy	Enum to use for ordering the results of getIssues().
Constants.IssueScope	Enum to use for specifying the scope when calling the various get issue methods.
Constants.IssueState	Enum to used to store the state of an issue.
Constants.JobScope	Enum to use for specifying the scope when calling getJobs().
Constants.LineType	Enum to use for specifying the line type for a commit comment.
Constants.MergeRequestOrderBy	Enum to use for ordering the results of getMergeRequests().
Constants.MergeRequestScope	Enum to use for specifying the scope for getMergeRequests methods.
Constants.MergeRequestSearchIn	Enum to use for specifying the scope of the search attribute when calling getMergeRequests().
Constants.MergeRequestState	Enum to use for querying the state of a MergeRequest
Constants.MilestoneState
Constants.PackageOrderBy	Enum to use for ordering the results of getPackages().
Constants.PackageStatus	Enum to use for filtering the results of getPackages().
Constants.PipelineOrderBy	Enum to use for ordering the results of getPipelines().
Constants.PipelineScope	Enum to use for specifying the scope when calling getPipelines().
Constants.ProjectAccessTokenScope	Enum to use for specifying the project token scope.
Constants.ProjectCreationLevel	Constant to specify the project_creation_level for the group.
Constants.ProjectOrderBy	Enum to use for ordering the results of getProjects().
Constants.ProjectSearchScope	Enum for the search scope when doing a projectSearch() with the SearchApi.
Constants.SearchScope	Enum for the search scope when doing a globalSearch() with the SearchApi.
Constants.SortOrder	Enum to use for ordering the results of various API calls.
Constants.SquashOption	Enum for the build_git_strategy of the project instance.
Constants.StateEvent	Enum to use for specifying the state of a merge request or issue update.
Constants.SubgroupCreationLevel	Constant to specify the subgroup_creation_level for the group.
Constants.TagOrderBy	Enum to use for ordering the results of getTags().
Constants.TargetType	Enum to use for specifying the event target_type.
Constants.TodoAction	Enum to use for specifying the action when doing a getTodos() with the TodosApi.
Constants.TodoState	Enum to use for specifying the state when doing a getTodos() with the TodosApi.
Constants.TodoType	Enum to use for specifying the type when doing a getTodos() with the TodosApi.
Constants.TokenType	Used to specify the type of authentication token.
GitLabApi.ApiVersion	Specifies the version of the GitLab API to communicate with.

Exception Summary

Exception	Description
GitLabApiException	This is the exception that will be thrown if any exception occurs while communicating with a GitLab API endpoint.