Constants.java 23.96 KiB
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<Encoding> 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<SortOrder> enumHelper = new JacksonJsonEnumHelper<>(SortOrder.class);
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
@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<EpicOrderBy> 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<IssueOrderBy> 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 getProjects(). */ public enum ProjectOrderBy { ID, NAME, PATH, CREATED_AT, UPDATED_AT, LAST_ACTIVITY_AT; private static JacksonJsonEnumHelper<ProjectOrderBy> enumHelper = new JacksonJsonEnumHelper<>(ProjectOrderBy.class); @JsonCreator
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
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<PipelineOrderBy> 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<MergeRequestOrderBy> 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; private static JacksonJsonEnumHelper<GroupOrderBy> enumHelper = new JacksonJsonEnumHelper<>(GroupOrderBy.class); @JsonCreator public static GroupOrderBy forValue(String value) { return enumHelper.forValue(value);
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
} @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<TagOrderBy> 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 specifying the scope when calling getPipelines(). */ public enum PipelineScope { RUNNING, PENDING, FINISHED, BRANCHES, TAGS; private static JacksonJsonEnumHelper<PipelineScope> 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<JobScope> enumHelper = new JacksonJsonEnumHelper<>(JobScope.class); @JsonCreator public static JobScope forValue(String value) { return enumHelper.forValue(value); } @JsonValue public String toValue() {
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
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<IssueScope> 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<MergeRequestScope> 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<MergeRequestState> 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)); }
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
} /** Enum to use for specifying the scope of the search attribute when calling getMergeRequests(). */ public enum MergeRequestSearchIn { TITLE, DESCRIPTION; private static JacksonJsonEnumHelper<MergeRequestSearchIn> 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<StateEvent> 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<IssueState> 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 {
421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
ACTIVE, CLOSED, ACTIVATE, CLOSE; private static JacksonJsonEnumHelper<MilestoneState> 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, CLOSED, REOPENED, PUSHED, COMMENTED, MERGED, JOINED, LEFT, DESTROYED, EXPIRED, REMOVED; private static JacksonJsonEnumHelper<ActionType> 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<TargetType> enumHelper = new JacksonJsonEnumHelper<>(TargetType.class, true, 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;
491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
private static JacksonJsonEnumHelper<LineType> 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<ImpersonationState> 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<String, ArchiveFormat> valuesMap = new HashMap<String, ArchiveFormat>(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); }
561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
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<CommitBuildState> 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<ApplicationScope> enumHelper = new JacksonJsonEnumHelper<>(ApplicationScope.class); @JsonCreator public static ApplicationScope forValue(String value) { return enumHelper.forValue(value); } @JsonValue public String toValue() { return (enumHelper.toString(this));
631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
} @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<SearchScope> 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<GroupSearchScope> 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<ProjectSearchScope> enumHelper = new JacksonJsonEnumHelper<>(ProjectSearchScope.class); @JsonCreator public static ProjectSearchScope forValue(String value) {
701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
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<TodoAction> 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<TodoState> 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<TodoType> enumHelper = new JacksonJsonEnumHelper<>(TodoType.class, true, true); @JsonCreator public static TodoType forValue(String value) { return enumHelper.forValue(value);
771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830
} @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 { CREATED, RUNNING, SUCCESS, FAILED, CANCELED; private static JacksonJsonEnumHelper<DeploymentStatus> 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<DeployTokenScope> 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)); } } }