Package org.gitlab4j.api

Interface Constants

All Known Implementing Classes:

AbstractApi, ApplicationsApi, ApplicationSettingsApi, AuditEventApi, AwardEmojiApi, BoardsApi, CommitsApi, ContainerRegistryApi, DeployKeysApi, DeploymentsApi, DeployTokensApi, DiscussionsApi, EnvironmentsApi, EpicsApi, EventsApi, ExternalStatusCheckApi, GroupApi, HealthCheckApi, ImportExportApi, IssuesApi, JobApi, KeysApi, LabelsApi, LicenseApi, LicenseTemplatesApi, MarkdownApi, MergeRequestApi, MilestonesApi, NamespaceApi, NotesApi, NotificationSettingsApi, PackagesApi, Pager, PipelineApi, ProjectApi, ProtectedBranchesApi, ReleaseLinksApi, ReleasesApi, RepositoryApi, RepositoryFileApi, RepositorySubmodulesApi, ResourceLabelEventsApi, ResourceStateEventsApi, RunnersApi, SearchApi, ServicesApi, SnippetsApi, SystemHooksApi, TagsApi, TodosApi, UserApi, WikisApi

public interface Constants

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NEXT_PAGE_HEADER	The index of the next page HTTP header key.
static final String	PAGE_HEADER	The index of the current page (starting at 1) HTTP header key.
static final String	PAGE_PARAM	Page param HTTP header key.
static final String	PER_PAGE	The number of items per page HTTP header key.
static final String	PER_PAGE_PARAM	Items per page param HTTP header key.
static final String	PREV_PAGE_HEADER	The index of the previous page HTTP header key.
static final String	TOTAL_HEADER	The total number of items HTTP header key.
static final String	TOTAL_PAGES_HEADER	The total number of pages HTTP header key.

Field Details

TOTAL_HEADER

static final String TOTAL_HEADER

The total number of items HTTP header key.

See Also:

• Constant Field Values

TOTAL_PAGES_HEADER

static final String TOTAL_PAGES_HEADER

The total number of pages HTTP header key.

See Also:

• Constant Field Values

PER_PAGE

static final String PER_PAGE

The number of items per page HTTP header key.

See Also:

• Constant Field Values

PAGE_HEADER

static final String PAGE_HEADER

The index of the current page (starting at 1) HTTP header key.

See Also:

• Constant Field Values

NEXT_PAGE_HEADER

static final String NEXT_PAGE_HEADER

The index of the next page HTTP header key.

See Also:

• Constant Field Values

PREV_PAGE_HEADER

static final String PREV_PAGE_HEADER

The index of the previous page HTTP header key.

See Also:

• Constant Field Values

PER_PAGE_PARAM

static final String PER_PAGE_PARAM

Items per page param HTTP header key.

See Also:

• Constant Field Values

PAGE_PARAM

static final String PAGE_PARAM

Page param HTTP header key.

See Also:

• Constant Field Values