All Classes
Class | Description |
---|---|
AbstractApi |
This class is the base class for all the sub API classes.
|
AbstractEvent | |
AbstractPushEvent | |
AbstractSystemHookEvent | |
AbstractUser<U extends AbstractUser<U>> | |
AcceptMergeRequestParams | |
AccessLevel | |
AccessRequest | |
AccessTokenUtils |
This class uses HTML scraping to create and revoke GitLab personal access tokens,
the user's Feed token, and for fetching the current Health Check access token.
|
AccessTokenUtils.Scope |
This enum defines the available scopes for a personal access token.
|
AllowedTo |
This class is used by the ProtectedBranchesAPi to set up the
allowed_to_push, allowed_to_merge, and allowed_to_unprotect values.
|
Application | |
ApplicationsApi |
This class implements the client side API for the GitLab Applications API.
|
ApplicationSettings | |
ApplicationSettingsApi |
This class implements the client side API for the GitLab Application Settings API.
|
ApprovalRule | |
ApprovalRuleParams | |
ApprovalState | |
ApprovedBy |
This class is used by various models to represent the approved_by property,
which can contain a User or Group instance.
|
Artifact | |
Artifact.FileType | |
ArtifactsFile | |
Assets |
This class is part of the Release class model.
|
Assets.Link | |
Assets.Source | |
Assignee | |
AuditEvent | |
AuditEventApi |
This class implements the client side API for the GitLab Instance Audit Event API.
|
AuditEventDetail | |
Author | |
AwardEmoji | |
AwardEmoji.AwardableType | |
AwardEmojiApi |
This class implements the client side API for the GitLab Award Emoji API calls.
|
Badge | |
Badge.BadgeKind | |
Blame | |
Board | |
BoardList | |
BoardsApi |
This class implements the client side API for the GitLab Issue Boards API calls.
|
Branch | |
BranchAccessLevel | |
BugzillaService | |
BuildCommit | |
BuildEvent |
The documentation at:
Job Events is incorrect, this class represents the actual content of the Job Hook event.
|
ChangeContainer<T> | |
ChangelogPayload | |
Changes | |
Comment | |
Commit | |
CommitAction | |
CommitAction.Action | |
CommitPayload | |
CommitRef | |
CommitRef.RefType | |
CommitsApi |
This class implements the client side API for the GitLab commits calls.
|
CommitStats | |
CommitStatus | |
CommitStatusFilter |
This class is used to filter commit status when getting lists of them.
|
CompareResults | |
Constants | |
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.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.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.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.
|
ContainerRegistryApi |
This class implements the client side API for the GitLab Container Registry API.
|
Contributor |
This class models the object for a repository contributor.
|
CustomAttribute | |
CustomIssueTrackerService | |
Deployable | |
DeployKey | |
DeployKeysApi |
This class implements the client side API for the GitLab Deploy Keys API calls.
|
Deployment | |
DeploymentEvent | |
DeploymentFilter | |
DeploymentsApi |
This class implements the client side API for the GitLab Deployments API calls.
|
DeployToken | |
DeployTokensApi |
This class implements the client side API for the GitLab Deploy Tokens API calls.
|
DetailedStatus |
This class is part of the Pipeline message.
|
Diff | |
DiffRef | |
Discussion | |
DiscussionsApi |
This class implements the client side API for the GitLab Discussions API.
|
Duration |
This class represents a duration in time.
|
DurationUtils | |
EmailChecker | |
EmailOnPushService | |
Environment | |
Environment.EnvironmentState | |
EnvironmentsApi |
This class provides an entry point to all the GitLab API Environments API calls.
|
Epic | |
EpicIssue | |
EpicsApi |
This class implements the client side API for the GitLab Epics and Epic Issues API calls.
|
Event | |
Event | |
EventChanges | |
EventCommit | |
EventData | |
EventIssue | |
EventLabel | |
EventLabel.LabelType | |
EventMergeRequest | |
EventProject | |
EventReleaseAssets | |
EventReleaseLink | |
EventReleaseSource | |
EventRepository | |
EventsApi |
This class implements the client side API for the GitLab events calls.
|
EventSnippet | |
ExportStatus | |
ExportStatus.Status |
Enum representing the status of the export.
|
ExternalWikiService | |
FileUpload | |
FileUtils |
This class provides static utility methods used throughout GitLab4J.
|
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.
|
GitLabApi.ApiVersion |
Specifies the version of the GitLab API to communicate with.
|
GitLabApiClient |
This class utilizes the Jersey client package to communicate with a GitLab API endpoint.
|
GitLabApiException |
This is the exception that will be thrown if any exception occurs while communicating
with a GitLab API endpoint.
|
GitLabApiForm |
This class extends the standard JAX-RS Form class to make it fluent.
|
GpgKey | |
GpgSignature | |
Group | |
GroupApi |
This class implements the client side API for the GitLab groups calls.
|
GroupFilter |
This class is used to filter Projects when getting lists of projects for a specified group.
|
GroupMemberSystemHookEvent | |
GroupParams |
This class is utilized by the
GroupApi.createGroup(GroupParams)
and GroupApi.updateGroup(Object, GroupParams) methods to set
the parameters for the call to the GitLab API. |
GroupParams.DefaultBranchProtectionLevel | |
GroupParams.ProjectCreationLevel |
Constant to specify the project_creation_level for the group.
|
GroupParams.SubgroupCreationLevel |
Constant to specify the subgroup_creation_level for the group.
|
GroupProjectsFilter |
This class is used to filter Projects when getting lists of projects for a specified group.
|
GroupSystemHookEvent | |
HealthCheckApi | |
HealthCheckInfo | |
HealthCheckItem | |
HealthCheckStatus | |
HipChatService | |
HookManager |
This interface provides a base class handler for processing GitLab Web Hook and System Hook callouts.
|
HttpRequestUtils | |
Identity | |
ImpersonationToken | |
ImpersonationToken.Scope |
Enum to specify the scope of an ImpersonationToken.
|
ImportExportApi |
This class provides an entry point to all the GitLab API project import/export calls.
|
ImportStatus | |
ImportStatus.Status |
Enum representing the status of the import.
|
ISO8601 |
This class provides utility methods for parsing and formatting ISO8601 formatted dates.
|
Issue | |
Issue.TaskCompletionStatus | |
IssueChanges | |
IssueEvent | |
IssueEvent | |
IssueEvent.ObjectAttributes | |
IssueEvent.ResourceType |
Enum to use for specifying the state events resource type.
|
IssueFilter |
This class is used to filter issues when getting lists of them.
|
IssueLink | |
IssuesApi |
This class provides an entry point to all the GitLab API Issue calls.
|
IssuesStatistics | |
IssuesStatistics.Counts | |
IssuesStatistics.Statistics | |
IssuesStatisticsFilter |
This class is used to filter issues when getting issue statistics. of them.
|
JacksonJson |
Jackson JSON Configuration and utility class.
|
JacksonJson.DateOnlySerializer |
JsonSerializer for serializing dates s yyyy-mm-dd in UTC timezone.
|
JacksonJson.JsonDateDeserializer |
JsonDeserializer for deserializing ISO8601 formatted dates.
|
JacksonJson.JsonDateSerializer |
JsonSerializer for serializing ISO8601 formatted dates.
|
JacksonJson.UserListDeserializer |
Deserializer for the odd User instances in the "approved_by" array in the merge_request JSON.
|
JacksonJson.UserListSerializer |
Serializer for the odd User instances in the "approved_by" array in the merge_request JSON.
|
JacksonJsonEnumHelper<E extends Enum<E>> | |
JiraService | |
Job | |
JobApi |
This class provides an entry point to all the GitLab API job calls.
|
JobEvent | |
JobStatus |
Enum for the various Job status values.
|
Key | |
KeysApi |
See:
https://docs.gitlab.com/ee/api/keys.html#get-user-by-fingerprint-of-ssh-key
|
KeySystemHookEvent | |
Label | |
LabelEvent | |
LabelEvent.ResourceType |
Enum to use for specifying the label event resource type.
|
LabelsApi |
This class provides an entry point to all the GitLab API project and group label calls.
|
License | |
LicenseApi |
This class provides an entry point to all the GitLab API license calls.
|
LicenseTemplate | |
LicenseTemplatesApi |
This class provides an entry point to all the GitLab API licenses calls.
|
Markdown | |
MarkdownApi |
This class provides an entry point to all the GitLab API markdown calls.
|
MarkdownRequest | |
MaskingLoggingFilter |
This class logs request and response info masking HTTP header values that are known to
contain sensitive information.
|
MattermostService | |
Member | |
Membership | |
MembershipSourceType | |
MergeRequest | |
MergeRequestApi |
This class implements the client side API for the GitLab merge request calls.
|
MergeRequestChanges | |
MergeRequestDiff | |
MergeRequestEvent | |
MergeRequestEvent.ObjectAttributes | |
MergeRequestFilter |
This class is used to filter merge requests when getting lists of them.
|
MergeRequestParams |
This class provides the form parameters for creating and updating merge requests.
|
MergeRequestSystemHookEvent | |
Milestone | |
MilestonesApi |
This class implements the client side API for the GitLab milestones calls.
|
Namespace | |
NamespaceApi |
This class implements the client side API for the GitLab namespace calls.
|
Note | |
Note.NoteableType | |
Note.OrderBy |
Enum to use for ordering the results.
|
Note.Type | |
NoteEvent | |
NoteEvent.NoteableType | |
NoteEvent.ObjectAttributes | |
NotesApi | |
NotificationService | |
NotificationService.BranchesToBeNotified | |
NotificationSettings | |
NotificationSettings.Events | |
NotificationSettings.Level |
Notification level
|
NotificationSettingsApi | |
Oauth2LoginStreamingOutput |
This StreamingOutput implementation is utilized to send a OAuth2 token request
in a secure manner.
|
OauthTokenResponse | |
Owner | |
Package | |
PackageFile | |
PackageFilter |
This class is used to filter Projects when getting lists of projects for a specified group.
|
PackagesApi |
This class implements the client side API for the GitLab Packages API.
|
PackageType | |
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.
|
Participant | |
Permissions | |
Pipeline | |
PipelineApi |
This class provides an entry point to all the GitLab API pipeline related calls.
|
PipelineEvent | |
PipelineEvent.ObjectAttributes | |
PipelineFilter |
This class is used to filter Pipelines when getting lists of them.
|
PipelineSchedule | |
PipelineStatus |
Enum for the various Pipeline status values.
|
Position | |
Position.PositionType | |
Project | |
Project.MergeMethod | |
ProjectAccess | |
ProjectApi |
This class provides an entry point to all the GitLab API project calls.
|
ProjectApprovalsConfig | |
ProjectFetches | |
ProjectFetches.DateCount | |
ProjectFetches.Fetches | |
ProjectFilter |
This class is used to filter Projects when getting lists of projects for a specified user.
|
ProjectHook | |
ProjectLicense | |
ProjectSharedGroup | |
ProjectStatistics |
This class contains the sizing information from the project.
|
ProjectSystemHookEvent | |
ProjectUser | |
ProtectedBranch | |
ProtectedBranchesApi |
This class provides an entry point to all the Protected Branches API calls.
|
ProtectedTag | |
ProtectedTag.CreateAccessLevel | |
ProxyClientConfig |
This class provides convenience methods to create ClientConfig properties so GitLabApi can use a proxy server.
|
PushData | |
PushEvent | |
PushRules | |
PushSystemHookEvent | |
References | |
RegistryRepository | |
RegistryRepositoryTag | |
Release | |
ReleaseEvent | |
ReleaseParams | |
ReleasesApi |
This class provides an entry point to all the GitLab Releases API calls.
|
RemoteMirror | |
Repository | |
RepositoryApi |
This class provides an entry point to all the GitLab API repository calls.
|
RepositoryChange | |
RepositoryFile | |
RepositoryFileApi |
This class provides an entry point to all the GitLab API repository files calls.
|
RepositorySystemHookEvent | |
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
|
Reviewer | |
Runner | |
Runner.RunnerStatus |
Enum to use for RunnersApi filtering on status.
|
Runner.RunnerType |
Enum to use for RunnersApi filtering on type.
|
RunnerDetail | |
RunnerDetail.RunnerAccessLevel |
Enum to use for RunnerDetail accessLevel property.
|
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.
|
SearchBlob | |
SecretString |
This class implements a CharSequence that can be cleared of it's contained characters.
|
ServicesApi |
Access for the services API.
|
Setting |
This enum provides constants and value validation for the available GitLab application settings.
|
SlackService | |
Snippet | |
SnippetsApi |
This class provides an entry point to all the GitLab Snippets API project calls.
|
SshKey | |
SystemHook | |
SystemHookEvent | |
SystemHookListener |
This interface defines an event listener for the event fired when
a System Hook notification has been received from a GitLab server.
|
SystemHookManager |
This class provides a handler for processing GitLab System Hook callouts.
|
SystemHooksApi |
This class implements the client side API for the GitLab System Hooks Keys API calls.
|
Tag | |
TagPushEvent | |
TagPushSystemHookEvent | |
TagsApi |
This class provides an entry point to all the GitLab Tags and Protected Tags API calls.
|
TaskCompletionStatus | |
TeamMemberSystemHookEvent | |
TimeStats | |
Todo | |
TodosApi |
This class implements the client side API for the GitLab Todos API.
|
TreeItem | |
TreeItem.Type | |
Trigger | |
UrlEncoder | |
User | |
UserApi |
This class provides an entry point to all the GitLab API users calls.
|
UserSystemHookEvent | |
Variable | |
Variable.Type |
Enum for the various Commit build status values.
|
Version | |
Visibility | |
WebHookListener |
This interface defines an event listener for the event fired when
a WebHook notification has been received from a GitLab server.
|
WebHookManager |
This class provides a handler for processing GitLab WebHook callouts.
|
WikiAttachment | |
WikiAttachment.Link | |
WikiPage | |
WikiPageEvent | |
WikiPageEvent.ObjectAttributes | |
WikiPageEvent.Wiki | |
WikisApi |
This class implements the client side API for the GitLab Wikis API.
|