org.gitlab4j.api.Constants Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gitlab4j-api Show documentation
Show all versions of gitlab4j-api Show documentation
GitLab4J-API (gitlab4j-api) provides a full featured Java client library for working with GitLab repositories and servers via the GitLab REST API.
package org.gitlab4j.api;
import java.util.HashMap;
import java.util.Map;
import org.gitlab4j.api.utils.JacksonJsonEnumHelper;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
public interface Constants {
/** The total number of items HTTP header key. */
public static final String TOTAL_HEADER = "X-Total";
/** The total number of pages HTTP header key. */
public static final String TOTAL_PAGES_HEADER = "X-Total-Pages";
/** The number of items per page HTTP header key. */
public static final String PER_PAGE = "X-Per-Page";
/** The index of the current page (starting at 1) HTTP header key. */
public static final String PAGE_HEADER = "X-Page";
/** The index of the next page HTTP header key. */
public static final String NEXT_PAGE_HEADER = "X-Next-Page";
/** The index of the previous page HTTP header key. */
public static final String PREV_PAGE_HEADER = "X-Prev-Page";
/** Items per page param HTTP header key. */
public static final String PER_PAGE_PARAM = "per_page";
/** Page param HTTP header key. */
public static final String PAGE_PARAM = "page";
/** Used to specify the type of authentication token. */
public enum TokenType {
ACCESS, OAUTH2_ACCESS, PRIVATE;
}
/** Enum to specify encoding of file contents. */
public enum Encoding {
TEXT, BASE64;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(Encoding.class);
@JsonCreator
public static Encoding forValue(String value) {
return enumHelper.forValue((value != null ? value.toLowerCase() : value));
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of various API calls. */
public enum SortOrder {
ASC, DESC;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(SortOrder.class);
@JsonCreator
public static SortOrder forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getEpics(). */
public enum EpicOrderBy {
CREATED_AT, UPDATED_AT;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(EpicOrderBy.class);
@JsonCreator
public static EpicOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getIssues(). */
public enum IssueOrderBy {
CREATED_AT, UPDATED_AT;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(IssueOrderBy.class);
@JsonCreator
public static IssueOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getPackages(). */
public enum PackageOrderBy {
NAME, CREATED_AT, VERSION, TYPE, PROJECT_PATH;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(PackageOrderBy.class);
@JsonCreator
public static PackageOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for filtering the results of getPackages(). */
public enum PackageStatus {
DEFAULT, HIDDEN, PROCESSING;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(PackageStatus.class);
@JsonCreator
public static PackageStatus forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getProjects(). */
public enum ProjectOrderBy {
ID, NAME, PATH, CREATED_AT, UPDATED_AT, LAST_ACTIVITY_AT;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(ProjectOrderBy.class);
@JsonCreator
public static ProjectOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getPipelines(). */
public enum PipelineOrderBy {
ID, STATUS, REF, UPDATED_AT, USER_ID;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(PipelineOrderBy.class);
@JsonCreator
public static PipelineOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getMergeRequests(). */
public enum MergeRequestOrderBy {
CREATED_AT, UPDATED_AT;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(MergeRequestOrderBy.class);
@JsonCreator
public static MergeRequestOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getGroups() and getSubGroups(). */
public enum GroupOrderBy {
NAME, PATH, ID, SIMILARITY;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(GroupOrderBy.class);
@JsonCreator
public static GroupOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getTags(). */
public enum TagOrderBy {
NAME, UPDATED;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(TagOrderBy.class);
@JsonCreator
public static TagOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getDeployments. */
public static enum DeploymentOrderBy {
ID, IID, CREATED_AT, UPDATED_AT, REF;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(DeploymentOrderBy.class);
@JsonCreator
public static DeploymentOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for ordering the results of getContibutors(). */
public enum ContributorOrderBy {
NAME, EMAIL, COMMITS;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(ContributorOrderBy.class);
@JsonCreator
public static ContributorOrderBy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the scope when calling getPipelines(). */
public enum PipelineScope {
RUNNING, PENDING, FINISHED, BRANCHES, TAGS;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(PipelineScope.class);
@JsonCreator
public static PipelineScope forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the scope when calling getJobs(). */
public enum JobScope {
CREATED, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(JobScope.class);
@JsonCreator
public static JobScope forValue(String value) { return enumHelper.forValue(value); }
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the scope when calling the various get issue methods. */
public enum IssueScope {
CREATED_BY_ME, ASSIGNED_TO_ME, ALL;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(IssueScope.class);
@JsonCreator
public static IssueScope forValue(String value) { return enumHelper.forValue(value); }
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the scope for getMergeRequests methods. */
public enum MergeRequestScope {
CREATED_BY_ME, ASSIGNED_TO_ME, ALL;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(MergeRequestScope.class);
@JsonCreator
public static MergeRequestScope forValue(String value) { return enumHelper.forValue(value); }
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for querying the state of a MergeRequest */
public enum MergeRequestState {
OPENED, CLOSED, LOCKED, MERGED, ALL;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(MergeRequestState.class);
@JsonCreator
public static MergeRequestState forValue(String value) { return enumHelper.forValue(value); }
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the scope of the search attribute when calling getMergeRequests(). */
public enum MergeRequestSearchIn {
TITLE, DESCRIPTION;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(MergeRequestSearchIn.class);
@JsonCreator
public static MergeRequestSearchIn forValue(String value) { return enumHelper.forValue(value); }
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the state of a merge request or issue update. */
public enum StateEvent {
CLOSE, REOPEN;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(StateEvent.class);
@JsonCreator
public static StateEvent forValue(String value) { return enumHelper.forValue(value); }
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to used to store the state of an issue. */
public enum IssueState {
OPENED, CLOSED, REOPENED;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(IssueState.class);
@JsonCreator
public static IssueState forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
public enum MilestoneState {
ACTIVE, CLOSED, ACTIVATE, CLOSE;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(MilestoneState.class);
@JsonCreator
public static MilestoneState forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the event action_type. */
public enum ActionType {
CREATED, UPDATED, OPENED, CLOSED, REOPENED, PUSHED, COMMENTED, MERGED, JOINED, LEFT, DESTROYED, EXPIRED, REMOVED, DELETED, APPROVED, ACCEPTED, IMPORTED;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(ActionType.class);
@JsonCreator
public static ActionType forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the event target_type. */
public enum TargetType {
ISSUE, MILESTONE, MERGE_REQUEST, NOTE, PROJECT, SNIPPET, USER;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(TargetType.class, true, false, true);
@JsonCreator
public static TargetType forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the line type for a commit comment. */
public enum LineType {
OLD, NEW;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(LineType.class);
@JsonCreator
public static LineType forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to specify the state of an ImpersonationToken. */
public enum ImpersonationState {
ALL, ACTIVE, INACTIVE;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(ImpersonationState.class);
@JsonCreator
public static ImpersonationState forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to specify the format of a downloaded archive. */
public enum ArchiveFormat {
BZ2, TAR, TAR_BZ2, TAR_GZ, TB2, TBZ, TBZ2, ZIP;
private final String value;
ArchiveFormat() {
this.value = name().toLowerCase().replace('_', '.');
}
private static Map valuesMap = new HashMap(8);
static {
for (ArchiveFormat archiveFormat : ArchiveFormat.values())
valuesMap.put(archiveFormat.value, archiveFormat);
}
public static ArchiveFormat forValue(String value) throws GitLabApiException {
if (value == null || value.trim().isEmpty()) {
return (null);
}
ArchiveFormat archiveFormat = valuesMap.get(value);
if (archiveFormat != null) {
return (archiveFormat);
}
throw new GitLabApiException("Invalid format! Options are tar.gz, tar.bz2, tbz, tbz2, tb2, bz2, tar, and zip.");
}
@Override
public String toString() {
return (value);
}
}
/**
* Enum for the various Commit build status values.
*/
public enum CommitBuildState {
PENDING, RUNNING, SUCCESS, FAILED, CANCELED;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(CommitBuildState.class);
@JsonCreator
public static CommitBuildState forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/**
* Enum for the various Application scope values.
*/
public enum ApplicationScope {
/** Access the authenticated user's API */
API,
/** Read the authenticated user's personal information */
READ_USER,
/** Perform API actions as any user in the system */
SUDO,
/** Allows read-access to the repository */
READ_REPOSITORY,
/** Authenticate using OpenID Connect */
OPENID,
/** Allows read-only access to the user's personal information using OpenID Connect */
PROFILE,
/** Allows read-only access to the user's primary email address using OpenID Connect */
EMAIL;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(ApplicationScope.class);
@JsonCreator
public static ApplicationScope forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/**
* Enum for the search scope when doing a globalSearch() with the SearchApi.
*/
public enum SearchScope {
PROJECTS, ISSUES, MERGE_REQUESTS, MILESTONES, SNIPPET_TITLES, SNIPPET_BLOBS, USERS,
BLOBS, COMMITS, WIKI_BLOBS;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(SearchScope.class);
@JsonCreator
public static SearchScope forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/**
* Enum for the search scope when doing a groupSearch() with the SearchApi.
*/
public enum GroupSearchScope {
PROJECTS, ISSUES, MERGE_REQUESTS, MILESTONES, USERS;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(GroupSearchScope.class);
@JsonCreator
public static GroupSearchScope forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/**
* Enum for the search scope when doing a projectSearch() with the SearchApi.
*/
public enum ProjectSearchScope {
BLOBS, COMMITS, ISSUES, MERGE_REQUESTS, MILESTONES, NOTES, WIKI_BLOBS, USERS;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(ProjectSearchScope.class);
@JsonCreator
public static ProjectSearchScope forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the action when doing a getTodos() with the TodosApi. */
public enum TodoAction {
ASSIGNED, MENTIONED, BUILD_FAILED, MARKED, APPROVAL_REQUIRED, UNMERGEABLE, DIRECTLY_ADDRESSED;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(TodoAction.class);
@JsonCreator
public static TodoAction forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the state when doing a getTodos() with the TodosApi. */
public enum TodoState {
PENDING, DONE;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(TodoState.class);
@JsonCreator
public static TodoState forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the type when doing a getTodos() with the TodosApi. */
public enum TodoType {
ISSUE, MERGE_REQUEST;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(TodoType.class, true, true);
@JsonCreator
public static TodoType forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the status of a deployment. */
public enum DeploymentStatus {
/**
* After some tests, {@link #CREATED} value is not a valid value.
*/
CREATED, RUNNING, SUCCESS, FAILED, CANCELED;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(DeploymentStatus.class);
@JsonCreator
public static DeploymentStatus forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the deploy token scope. */
public enum DeployTokenScope {
READ_REPOSITORY, READ_REGISTRY;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(DeployTokenScope.class);
@JsonCreator
public static DeployTokenScope forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum for the build_git_strategy of the project instance. */
enum SquashOption {
NEVER, ALWAYS, DEFAULT_ON, DEFAULT_OFF;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(SquashOption.class);
@JsonCreator
public static SquashOption forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum for the build_git_strategy of the project instance. */
enum BuildGitStrategy {
FETCH, CLONE;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(BuildGitStrategy.class);
@JsonCreator
public static BuildGitStrategy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
enum AutoDevopsDeployStrategy {
CONTINUOUS, MANUAL, TIMED_INCREMENTAL;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(AutoDevopsDeployStrategy.class);
@JsonCreator
public static AutoDevopsDeployStrategy forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
/** Enum to use for specifying the Event scope. */
public enum EventScope {
ALL;
private static JacksonJsonEnumHelper enumHelper = new JacksonJsonEnumHelper<>(EventScope.class);
@JsonCreator
public static EventScope forValue(String value) {
return enumHelper.forValue(value);
}
@JsonValue
public String toValue() {
return (enumHelper.toString(this));
}
@Override
public String toString() {
return (enumHelper.toString(this));
}
}
}