Package org.gitlab4j.api

Class BoardsApi

  • All Implemented Interfaces:
    org.gitlab4j.models.Constants
    public class BoardsApi
extends AbstractApi
    This class implements the client side API for the GitLab Issue Boards API calls. NOTE: If a user is not a member of a group and the group is private, a GET request on that group will result to a 404 status code.
    See Also:
    GitLab Issue Boards API Documentaion

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gitlab4j.models.Constants

        org.gitlab4j.models.Constants.ActionType, org.gitlab4j.models.Constants.ApplicationScope, org.gitlab4j.models.Constants.ArchiveFormat, org.gitlab4j.models.Constants.AutoDevopsDeployStrategy, org.gitlab4j.models.Constants.BuildGitStrategy, org.gitlab4j.models.Constants.CommitBuildState, org.gitlab4j.models.Constants.ContributorOrderBy, org.gitlab4j.models.Constants.DefaultBranchProtectionLevel, org.gitlab4j.models.Constants.DeploymentOrderBy, org.gitlab4j.models.Constants.DeploymentStatus, org.gitlab4j.models.Constants.DeployTokenScope, org.gitlab4j.models.Constants.Encoding, org.gitlab4j.models.Constants.EpicOrderBy, org.gitlab4j.models.Constants.EventScope, org.gitlab4j.models.Constants.GroupOrderBy, org.gitlab4j.models.Constants.GroupSearchScope<T extends java.lang.Object>, org.gitlab4j.models.Constants.ImpersonationState, org.gitlab4j.models.Constants.IssueOrderBy, org.gitlab4j.models.Constants.IssueScope, org.gitlab4j.models.Constants.IssueState, org.gitlab4j.models.Constants.JobScope, org.gitlab4j.models.Constants.LineType, org.gitlab4j.models.Constants.MergeRequestOrderBy, org.gitlab4j.models.Constants.MergeRequestScope, org.gitlab4j.models.Constants.MergeRequestSearchIn, org.gitlab4j.models.Constants.MergeRequestState, org.gitlab4j.models.Constants.MilestoneState, org.gitlab4j.models.Constants.PackageOrderBy, org.gitlab4j.models.Constants.PackageStatus, org.gitlab4j.models.Constants.PipelineOrderBy, org.gitlab4j.models.Constants.PipelineScope, org.gitlab4j.models.Constants.PipelineSource, org.gitlab4j.models.Constants.ProjectAccessTokenScope, org.gitlab4j.models.Constants.ProjectCreationLevel, org.gitlab4j.models.Constants.ProjectOrderBy, org.gitlab4j.models.Constants.ProjectSearchScope<T extends java.lang.Object>, org.gitlab4j.models.Constants.SearchScope<T extends java.lang.Object>, org.gitlab4j.models.Constants.SortOrder, org.gitlab4j.models.Constants.SquashOption, org.gitlab4j.models.Constants.StateEvent, org.gitlab4j.models.Constants.SubgroupCreationLevel, org.gitlab4j.models.Constants.TagOrderBy, org.gitlab4j.models.Constants.TargetType, org.gitlab4j.models.Constants.TodoAction, org.gitlab4j.models.Constants.TodoState, org.gitlab4j.models.Constants.TodoType, org.gitlab4j.models.Constants.TokenType

    • Field Summary

      • Fields inherited from interface org.gitlab4j.models.Constants

        NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

    • Constructor Summary

      Constructors 
      Constructor Description
      BoardsApi​(GitLabApi gitLabApi)  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      org.gitlab4j.api.models.Board createBoard​(java.lang.Object projectIdOrPath, java.lang.String name)
      Deprecated.
      use createProjectIssueBoard(Object, String) instead
      org.gitlab4j.api.models.BoardList createBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long labelId)
      Deprecated.
      use createProjectIssueBoardList(Object, Long, Long, Long, Long, Long) instead
      org.gitlab4j.api.models.BoardList createBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long labelId, java.lang.Long assigneeId, java.lang.Long milestoneId, java.lang.Long iterationId)
      Deprecated.
      use createProjectIssueBoardList(Object, Long, Long, Long, Long, Long) instead
      org.gitlab4j.api.models.Board createGroupIssueBoard​(java.lang.Object groupIdOrPath, java.lang.String name)
      Creates a new Issue Board.
      org.gitlab4j.api.models.BoardList createGroupIssueBoardList​(java.lang.Object groupIdOrPath, java.lang.Long boardId, java.lang.Long labelId, java.lang.Long assigneeId, java.lang.Long milestoneId, java.lang.Long iterationId)
      Creates a new Issue Board list.
      org.gitlab4j.api.models.Board createProjectIssueBoard​(java.lang.Object projectIdOrPath, java.lang.String name)
      Creates a new Issue Board.
      org.gitlab4j.api.models.BoardList createProjectIssueBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long labelId, java.lang.Long assigneeId, java.lang.Long milestoneId, java.lang.Long iterationId)
      Creates a new Issue Board list.
      void deleteBoard​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Deprecated.
      use deleteBoard(Object, Long) instead
      void deleteBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Deprecated.
      use deleteProjectIssueBoardList(Object, Long, Long) instead
      void deleteGroupIssueBoard​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Soft deletes an existing Issue Board.
      void deleteGroupIssueBoardList​(java.lang.Object groupIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Soft deletes an existing Issue Board list.
      void deleteProjectIssueBoard​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Soft deletes an existing Issue Board.
      void deleteProjectIssueBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Soft deletes an existing Issue Board list.
      org.gitlab4j.api.models.Board getBoard​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Deprecated.
      use getProjectIssueBoard(Object, Long) instead
      org.gitlab4j.api.models.BoardList getBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Deprecated.
      use getProjectIssueBoardList(Object, Long, Long) instead
      java.util.List<org.gitlab4j.api.models.BoardList> getBoardLists​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Deprecated.
      use getProjectIssueBoardLists(Object, Long) instead
      Pager<org.gitlab4j.api.models.BoardList> getBoardLists​(java.lang.Object projectIdOrPath, java.lang.Long boardId, int itemsPerPage)
      Deprecated.
      use getProjectIssueBoardLists(Object, Long, int) instead
      java.util.List<org.gitlab4j.api.models.BoardList> getBoardLists​(java.lang.Object projectIdOrPath, java.lang.Long boardId, int page, int perPage)
      Deprecated.
      use getProjectIssueBoardLists(Object, Long, int, int) instead
      java.util.List<org.gitlab4j.api.models.Board> getBoards​(java.lang.Object projectIdOrPath)
      Deprecated.
      use getProjectIssueBoards(Object) instead
      Pager<org.gitlab4j.api.models.Board> getBoards​(java.lang.Object projectIdOrPath, int itemsPerPage)
      Deprecated.
      use getProjectIssueBoards(Object, int) instead
      java.util.List<org.gitlab4j.api.models.Board> getBoards​(java.lang.Object projectIdOrPath, int page, int perPage)
      Deprecated.
      use getProjectIssueBoards(Object, int, int) instead
      java.util.stream.Stream<org.gitlab4j.api.models.BoardList> getBoardsListsStream​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Deprecated.
      use getProjectIssueBoardsListsStream(Object, Long) instead
      java.util.stream.Stream<org.gitlab4j.api.models.Board> getBoardsStream​(java.lang.Object projectIdOrPath)
      Deprecated.
      use getProjectIssueBoardsStream(Object) instead
      org.gitlab4j.api.models.Board getGroupEpicBoard​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Get a single epic board.
      org.gitlab4j.api.models.BoardList getGroupEpicBoardList​(java.lang.Object groupIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Get a single epic board list.
      java.util.List<org.gitlab4j.api.models.BoardList> getGroupEpicBoardLists​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Get a list of the board’s lists.
      Pager<org.gitlab4j.api.models.BoardList> getGroupEpicBoardLists​(java.lang.Object groupIdOrPath, java.lang.Long boardId, int itemsPerPage)
      Get a Pager of the board’s lists.
      java.util.List<org.gitlab4j.api.models.BoardList> getGroupEpicBoardLists​(java.lang.Object groupIdOrPath, java.lang.Long boardId, int page, int perPage)
      Get a list of the board’s lists for the specified group to using the specified page and per page setting.
      java.util.List<org.gitlab4j.api.models.Board> getGroupEpicBoards​(java.lang.Object groupIdOrPath)
      Lists epic boards in the given group.
      Pager<org.gitlab4j.api.models.Board> getGroupEpicBoards​(java.lang.Object groupIdOrPath, int itemsPerPage)
      Get a Pager of all epic boards for the specified group.
      java.util.List<org.gitlab4j.api.models.Board> getGroupEpicBoards​(java.lang.Object groupIdOrPath, int page, int perPage)
      Get all epic boards for the specified group using the specified page and per page setting
      java.util.stream.Stream<org.gitlab4j.api.models.BoardList> getGroupEpicBoardsListsStream​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Get a Stream of the board’s lists.
      java.util.stream.Stream<org.gitlab4j.api.models.Board> getGroupEpicBoardsStream​(java.lang.Object groupIdOrPath)
      Get a Stream of all epic boards for the specified group.
      org.gitlab4j.api.models.Board getGroupIssueBoard​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Get a single issue board.
      org.gitlab4j.api.models.BoardList getGroupIssueBoardList​(java.lang.Object groupIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Get a single issue board list.
      java.util.List<org.gitlab4j.api.models.BoardList> getGroupIssueBoardLists​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Get a list of the board’s lists.
      Pager<org.gitlab4j.api.models.BoardList> getGroupIssueBoardLists​(java.lang.Object groupIdOrPath, java.lang.Long boardId, int itemsPerPage)
      Get a Pager of the board’s lists.
      java.util.List<org.gitlab4j.api.models.BoardList> getGroupIssueBoardLists​(java.lang.Object groupIdOrPath, java.lang.Long boardId, int page, int perPage)
      Get a list of the board’s lists for the specified group to using the specified page and per page setting.
      java.util.List<org.gitlab4j.api.models.Board> getGroupIssueBoards​(java.lang.Object groupIdOrPath)
      Lists Issue Boards in the given group.
      Pager<org.gitlab4j.api.models.Board> getGroupIssueBoards​(java.lang.Object groupIdOrPath, int itemsPerPage)
      Get a Pager of all issue boards for the specified group.
      java.util.List<org.gitlab4j.api.models.Board> getGroupIssueBoards​(java.lang.Object groupIdOrPath, int page, int perPage)
      Get all issue boards for the specified group using the specified page and per page setting
      java.util.stream.Stream<org.gitlab4j.api.models.BoardList> getGroupIssueBoardsListsStream​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Get a Stream of the board’s lists.
      java.util.stream.Stream<org.gitlab4j.api.models.Board> getGroupIssueBoardsStream​(java.lang.Object groupIdOrPath)
      Get a Stream of all issue boards for the specified group.
      java.util.Optional<org.gitlab4j.api.models.Board> getOptionalBoard​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Deprecated.
      use getOptionalProjectIssueBoard(Object, Long) instead
      java.util.Optional<org.gitlab4j.api.models.BoardList> getOptionalBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Deprecated.
      use getOptionalProjectIssueBoardList(Object, Long, Long) instead
      java.util.Optional<org.gitlab4j.api.models.Board> getOptionalGroupEpicBoard​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Get an epic board as an Optional instance.
      java.util.Optional<org.gitlab4j.api.models.BoardList> getOptionalGroupEpicBoardList​(java.lang.Object groupIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Get a single epic board list as an Optional instance.
      java.util.Optional<org.gitlab4j.api.models.Board> getOptionalGroupIssueBoard​(java.lang.Object groupIdOrPath, java.lang.Long boardId)
      Get an issue board as an Optional instance.
      java.util.Optional<org.gitlab4j.api.models.BoardList> getOptionalGroupIssueBoardList​(java.lang.Object groupIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Get a single issue board list as an Optional instance.
      java.util.Optional<org.gitlab4j.api.models.Board> getOptionalProjectIssueBoard​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Get an issue board as an Optional instance.
      java.util.Optional<org.gitlab4j.api.models.BoardList> getOptionalProjectIssueBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Get a single issue board list as an Optional instance.
      org.gitlab4j.api.models.Board getProjectIssueBoard​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Get a single issue board.
      org.gitlab4j.api.models.BoardList getProjectIssueBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long listId)
      Get a single issue board list.
      java.util.List<org.gitlab4j.api.models.BoardList> getProjectIssueBoardLists​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Get a list of the board’s lists.
      Pager<org.gitlab4j.api.models.BoardList> getProjectIssueBoardLists​(java.lang.Object projectIdOrPath, java.lang.Long boardId, int itemsPerPage)
      Get a Pager of the board’s lists.
      java.util.List<org.gitlab4j.api.models.BoardList> getProjectIssueBoardLists​(java.lang.Object projectIdOrPath, java.lang.Long boardId, int page, int perPage)
      Get a list of the board’s lists for the specified project to using the specified page and per page setting.
      java.util.List<org.gitlab4j.api.models.Board> getProjectIssueBoards​(java.lang.Object projectIdOrPath)
      Lists Issue Boards in the given project.
      Pager<org.gitlab4j.api.models.Board> getProjectIssueBoards​(java.lang.Object projectIdOrPath, int itemsPerPage)
      Get a Pager of all issue boards for the specified project.
      java.util.List<org.gitlab4j.api.models.Board> getProjectIssueBoards​(java.lang.Object projectIdOrPath, int page, int perPage)
      Get all issue boards for the specified project using the specified page and per page setting
      java.util.stream.Stream<org.gitlab4j.api.models.BoardList> getProjectIssueBoardsListsStream​(java.lang.Object projectIdOrPath, java.lang.Long boardId)
      Get a Stream of the board’s lists.
      java.util.stream.Stream<org.gitlab4j.api.models.Board> getProjectIssueBoardsStream​(java.lang.Object projectIdOrPath)
      Get a Stream of all issue boards for the specified project.
      org.gitlab4j.api.models.Board updateBoard​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.String name, java.lang.Boolean hideBacklogList, java.lang.Boolean hideClosedList, java.lang.Long assigneeId, java.lang.Long milestoneId, java.lang.String labels, java.lang.Integer weight)
      Deprecated.
      use updateProjectIssueBoard(Object, Long, String, Boolean, Boolean, Long, Long, String, Integer) instead
      org.gitlab4j.api.models.BoardList updateBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long listId, java.lang.Integer position)
      Deprecated.
      use updateProjectIssueBoardList(Object, Long, Long, Integer) instead
      org.gitlab4j.api.models.Board updateGroupIssueBoard​(java.lang.Object groupIdOrPath, java.lang.Long boardId, java.lang.String name, java.lang.Boolean hideBacklogList, java.lang.Boolean hideClosedList, java.lang.Long assigneeId, java.lang.Long milestoneId, java.lang.String labels, java.lang.Integer weight)
      Updates an existing Issue Board.
      org.gitlab4j.api.models.BoardList updateGroupIssueBoardList​(java.lang.Object groupIdOrPath, java.lang.Long boardId, java.lang.Long listId, java.lang.Integer position)
      Updates an existing Issue Board list.
      org.gitlab4j.api.models.Board updateProjectIssueBoard​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.String name, java.lang.Boolean hideBacklogList, java.lang.Boolean hideClosedList, java.lang.Long assigneeId, java.lang.Long milestoneId, java.lang.String labels, java.lang.Integer weight)
      Updates an existing Issue Board.
      org.gitlab4j.api.models.BoardList updateProjectIssueBoardList​(java.lang.Object projectIdOrPath, java.lang.Long boardId, java.lang.Long listId, java.lang.Integer position)
      Updates an existing Issue Board list.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BoardsApi

        public BoardsApi​(GitLabApi gitLabApi)

    • Method Detail

      • getBoards

        @Deprecated
public java.util.List<org.gitlab4j.api.models.Board> getBoards​(java.lang.Object projectIdOrPath)
                                                        throws GitLabApiException
        Deprecated.
        use getProjectIssueBoards(Object) instead
        Lists Issue Boards in the given project. 
        GitLab Endpoint: GET /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        Returns:
        a list of project's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getBoards

        @Deprecated
public java.util.List<org.gitlab4j.api.models.Board> getBoards​(java.lang.Object projectIdOrPath,
                                                               int page,
                                                               int perPage)
                                                        throws GitLabApiException
        Deprecated.
        use getProjectIssueBoards(Object, int, int) instead
        Get all issue boards for the specified project using the specified page and per page setting 
        GitLab Endpoint: GET /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        page - the page to get
        perPage - the number of items per page
        Returns:
        a list of project's Boards in the specified range
        Throws:
        GitLabApiException - if any exception occurs

      • getBoards

        @Deprecated
public Pager<org.gitlab4j.api.models.Board> getBoards​(java.lang.Object projectIdOrPath,
                                                      int itemsPerPage)
                                               throws GitLabApiException
        Deprecated.
        use getProjectIssueBoards(Object, int) instead
        Get a Pager of all issue boards for the specified project. 
        GitLab Endpoint: GET /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        itemsPerPage - the number of items per page
        Returns:
        a Pager of project's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getBoardsStream

        @Deprecated
public java.util.stream.Stream<org.gitlab4j.api.models.Board> getBoardsStream​(java.lang.Object projectIdOrPath)
                                                                       throws GitLabApiException
        Deprecated.
        use getProjectIssueBoardsStream(Object) instead
        Get a Stream of all issue boards for the specified project. 
        GitLab Endpoint: GET /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        Returns:
        a Stream of project's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getBoard

        @Deprecated
public org.gitlab4j.api.models.Board getBoard​(java.lang.Object projectIdOrPath,
                                              java.lang.Long boardId)
                                       throws GitLabApiException
        Deprecated.
        use getProjectIssueBoard(Object, Long) instead
        Get a single issue board. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Returns:
        a Board instance for the specified board ID
        Throws:
        GitLabApiException - if any exception occurs

      • getOptionalBoard

        @Deprecated
public java.util.Optional<org.gitlab4j.api.models.Board> getOptionalBoard​(java.lang.Object projectIdOrPath,
                                                                          java.lang.Long boardId)
        Deprecated.
        use getOptionalProjectIssueBoard(Object, Long) instead
        Get an issue board as an Optional instance. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Returns:
        the Board instance for the specified board ID as an Optional instance

      • createBoard

        @Deprecated
public org.gitlab4j.api.models.Board createBoard​(java.lang.Object projectIdOrPath,
                                                 java.lang.String name)
                                          throws GitLabApiException
        Deprecated.
        use createProjectIssueBoard(Object, String) instead
        Creates a new Issue Board. 
        GitLab Endpoint: POST /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        name - the name for the new board
        Returns:
        the created Board instance
        Throws:
        GitLabApiException - if any exception occurs

      • updateBoard

        @Deprecated
public org.gitlab4j.api.models.Board updateBoard​(java.lang.Object projectIdOrPath,
                                                 java.lang.Long boardId,
                                                 java.lang.String name,
                                                 java.lang.Boolean hideBacklogList,
                                                 java.lang.Boolean hideClosedList,
                                                 java.lang.Long assigneeId,
                                                 java.lang.Long milestoneId,
                                                 java.lang.String labels,
                                                 java.lang.Integer weight)
                                          throws GitLabApiException
        Deprecated.
        use updateProjectIssueBoard(Object, Long, String, Boolean, Boolean, Long, Long, String, Integer) instead
        Updates an existing Issue Board. 
        GitLab Endpoint: PUT /projects/:id/boards/:board_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance, required
        boardId - the ID of the board, required
        name - the new name of the board, optional (can be null)
        hideBacklogList - hide the Open list, optional (can be null)
        hideClosedList - hide the Closed list, optional (can be null)
        assigneeId - the assignee the board should be scoped to, optional (can be null)
        milestoneId - the milestone the board should be scoped to, optional (can be null)
        labels - a comma-separated list of label names which the board should be scoped to, optional (can be null)
        weight - the weight range from 0 to 9, to which the board should be scoped to, optional (can be null)
        Returns:
        the updated Board instance
        Throws:
        GitLabApiException - if any exception occurs

      • deleteBoard

        @Deprecated
public void deleteBoard​(java.lang.Object projectIdOrPath,
                        java.lang.Long boardId)
                 throws GitLabApiException
        Deprecated.
        use deleteBoard(Object, Long) instead
        Soft deletes an existing Issue Board. 
        GitLab Endpoint: DELETE /projects/:id/boards/:board_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Throws:
        GitLabApiException - if any exception occurs

      • getBoardLists

        @Deprecated
public java.util.List<org.gitlab4j.api.models.BoardList> getBoardLists​(java.lang.Object projectIdOrPath,
                                                                       java.lang.Long boardId)
                                                                throws GitLabApiException
        Deprecated.
        use getProjectIssueBoardLists(Object, Long) instead
        Get a list of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Returns:
        a list of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getBoardLists

        @Deprecated
public java.util.List<org.gitlab4j.api.models.BoardList> getBoardLists​(java.lang.Object projectIdOrPath,
                                                                       java.lang.Long boardId,
                                                                       int page,
                                                                       int perPage)
                                                                throws GitLabApiException
        Deprecated.
        use getProjectIssueBoardLists(Object, Long, int, int) instead
        Get a list of the board’s lists for the specified project to using the specified page and per page setting. Does not include open and closed lists. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        page - the page to get
        perPage - the number of Boards per page
        Returns:
        a list of the issue board's lists in the specified range
        Throws:
        GitLabApiException - if any exception occurs

      • getBoardLists

        @Deprecated
public Pager<org.gitlab4j.api.models.BoardList> getBoardLists​(java.lang.Object projectIdOrPath,
                                                              java.lang.Long boardId,
                                                              int itemsPerPage)
                                                       throws GitLabApiException
        Deprecated.
        use getProjectIssueBoardLists(Object, Long, int) instead
        Get a Pager of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        itemsPerPage - the number of Board instances that will be fetched per page
        Returns:
        a Pager of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getBoardsListsStream

        @Deprecated
public java.util.stream.Stream<org.gitlab4j.api.models.BoardList> getBoardsListsStream​(java.lang.Object projectIdOrPath,
                                                                                       java.lang.Long boardId)
                                                                                throws GitLabApiException
        Deprecated.
        use getProjectIssueBoardsListsStream(Object, Long) instead
        Get a Stream of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Returns:
        a Stream of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getBoardList

        @Deprecated
public org.gitlab4j.api.models.BoardList getBoardList​(java.lang.Object projectIdOrPath,
                                                      java.lang.Long boardId,
                                                      java.lang.Long listId)
                                               throws GitLabApiException
        Deprecated.
        use getProjectIssueBoardList(Object, Long, Long) instead
        Get a single issue board list. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists/:list_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        listId - the ID of the board lists to get
        Returns:
        a BoardList instance for the specified board ID and list ID
        Throws:
        GitLabApiException - if any exception occurs

      • getOptionalBoardList

        @Deprecated
public java.util.Optional<org.gitlab4j.api.models.BoardList> getOptionalBoardList​(java.lang.Object projectIdOrPath,
                                                                                  java.lang.Long boardId,
                                                                                  java.lang.Long listId)
        Deprecated.
        use getOptionalProjectIssueBoardList(Object, Long, Long) instead
        Get a single issue board list as an Optional instance. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists/:list_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        listId - the ID of the board lists to get
        Returns:
        a BoardList instance for the specified board ID and list ID as an Optional instance

      • createBoardList

        @Deprecated
public org.gitlab4j.api.models.BoardList createBoardList​(java.lang.Object projectIdOrPath,
                                                         java.lang.Long boardId,
                                                         java.lang.Long labelId,
                                                         java.lang.Long assigneeId,
                                                         java.lang.Long milestoneId,
                                                         java.lang.Long iterationId)
                                                  throws GitLabApiException
        Deprecated.
        use createProjectIssueBoardList(Object, Long, Long, Long, Long, Long) instead
        Creates a new Issue Board list. 
        GitLab Endpoint: POST /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        labelId - the ID of the label, optional (can be null)
        assigneeId - The ID of a user. Premium and Ultimate only, optional (can be null)
        milestoneId - The ID of a milestone. Premium and Ultimate only, optional (can be null)
        iterationId - The ID of a milestone. Premium and Ultimate only, optional (can be null)
        Returns:
        the created BoardList instance
        Throws:
        GitLabApiException - if any exception occurs

      • createBoardList

        @Deprecated
public org.gitlab4j.api.models.BoardList createBoardList​(java.lang.Object projectIdOrPath,
                                                         java.lang.Long boardId,
                                                         java.lang.Long labelId)
                                                  throws GitLabApiException
        Deprecated.
        use createProjectIssueBoardList(Object, Long, Long, Long, Long, Long) instead
        Creates a new Issue Board list. 
        GitLab Endpoint: POST /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        labelId - the ID of the label
        Returns:
        the created BoardList instance
        Throws:
        GitLabApiException - if any exception occurs

      • updateBoardList

        @Deprecated
public org.gitlab4j.api.models.BoardList updateBoardList​(java.lang.Object projectIdOrPath,
                                                         java.lang.Long boardId,
                                                         java.lang.Long listId,
                                                         java.lang.Integer position)
                                                  throws GitLabApiException
        Deprecated.
        use updateProjectIssueBoardList(Object, Long, Long, Integer) instead
        Updates an existing Issue Board list. This call is used to change list position. 
        GitLab Endpoint: PUT /projects/:id/boards/:board_id/lists/:list_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        listId - the ID of the list
        position - the new position for the list
        Returns:
        the updated BoardList instance
        Throws:
        GitLabApiException - if any exception occurs

      • deleteBoardList

        @Deprecated
public void deleteBoardList​(java.lang.Object projectIdOrPath,
                            java.lang.Long boardId,
                            java.lang.Long listId)
                     throws GitLabApiException
        Deprecated.
        use deleteProjectIssueBoardList(Object, Long, Long) instead
        Soft deletes an existing Issue Board list. Only for admins and project owners. 
        GitLab Endpoint: DELETE /projects/:id/boards/:board_id/lists/:list_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        listId - the ID of the list
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoards

        public java.util.List<org.gitlab4j.api.models.Board> getProjectIssueBoards​(java.lang.Object projectIdOrPath)
                                                                    throws GitLabApiException
        Lists Issue Boards in the given project. 
        GitLab Endpoint: GET /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        Returns:
        a list of project's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoards

        public java.util.List<org.gitlab4j.api.models.Board> getProjectIssueBoards​(java.lang.Object projectIdOrPath,
                                                                           int page,
                                                                           int perPage)
                                                                    throws GitLabApiException
        Get all issue boards for the specified project using the specified page and per page setting 
        GitLab Endpoint: GET /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        page - the page to get
        perPage - the number of items per page
        Returns:
        a list of project's Boards in the specified range
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoards

        public Pager<org.gitlab4j.api.models.Board> getProjectIssueBoards​(java.lang.Object projectIdOrPath,
                                                                  int itemsPerPage)
                                                           throws GitLabApiException
        Get a Pager of all issue boards for the specified project. 
        GitLab Endpoint: GET /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        itemsPerPage - the number of items per page
        Returns:
        a Pager of project's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoardsStream

        public java.util.stream.Stream<org.gitlab4j.api.models.Board> getProjectIssueBoardsStream​(java.lang.Object projectIdOrPath)
                                                                                   throws GitLabApiException
        Get a Stream of all issue boards for the specified project. 
        GitLab Endpoint: GET /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        Returns:
        a Stream of project's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoard

        public org.gitlab4j.api.models.Board getProjectIssueBoard​(java.lang.Object projectIdOrPath,
                                                          java.lang.Long boardId)
                                                   throws GitLabApiException
        Get a single issue board. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Returns:
        a Board instance for the specified board ID
        Throws:
        GitLabApiException - if any exception occurs

      • getOptionalProjectIssueBoard

        public java.util.Optional<org.gitlab4j.api.models.Board> getOptionalProjectIssueBoard​(java.lang.Object projectIdOrPath,
                                                                                      java.lang.Long boardId)
        Get an issue board as an Optional instance. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Returns:
        the Board instance for the specified board ID as an Optional instance

      • createProjectIssueBoard

        public org.gitlab4j.api.models.Board createProjectIssueBoard​(java.lang.Object projectIdOrPath,
                                                             java.lang.String name)
                                                      throws GitLabApiException
        Creates a new Issue Board. 
        GitLab Endpoint: POST /projects/:id/boards
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        name - the name for the new board
        Returns:
        the created Board instance
        Throws:
        GitLabApiException - if any exception occurs

      • updateProjectIssueBoard

        public org.gitlab4j.api.models.Board updateProjectIssueBoard​(java.lang.Object projectIdOrPath,
                                                             java.lang.Long boardId,
                                                             java.lang.String name,
                                                             java.lang.Boolean hideBacklogList,
                                                             java.lang.Boolean hideClosedList,
                                                             java.lang.Long assigneeId,
                                                             java.lang.Long milestoneId,
                                                             java.lang.String labels,
                                                             java.lang.Integer weight)
                                                      throws GitLabApiException
        Updates an existing Issue Board. 
        GitLab Endpoint: PUT /projects/:id/boards/:board_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance, required
        boardId - the ID of the board, required
        name - the new name of the board, optional (can be null)
        hideBacklogList - hide the Open list, optional (can be null)
        hideClosedList - hide the Closed list, optional (can be null)
        assigneeId - the assignee the board should be scoped to, optional (can be null)
        milestoneId - the milestone the board should be scoped to, optional (can be null)
        labels - a comma-separated list of label names which the board should be scoped to, optional (can be null)
        weight - the weight range from 0 to 9, to which the board should be scoped to, optional (can be null)
        Returns:
        the updated Board instance
        Throws:
        GitLabApiException - if any exception occurs

      • deleteProjectIssueBoard

        public void deleteProjectIssueBoard​(java.lang.Object projectIdOrPath,
                                    java.lang.Long boardId)
                             throws GitLabApiException
        Soft deletes an existing Issue Board. 
        GitLab Endpoint: DELETE /projects/:id/boards/:board_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoardLists

        public java.util.List<org.gitlab4j.api.models.BoardList> getProjectIssueBoardLists​(java.lang.Object projectIdOrPath,
                                                                                   java.lang.Long boardId)
                                                                            throws GitLabApiException
        Get a list of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Returns:
        a list of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoardLists

        public java.util.List<org.gitlab4j.api.models.BoardList> getProjectIssueBoardLists​(java.lang.Object projectIdOrPath,
                                                                                   java.lang.Long boardId,
                                                                                   int page,
                                                                                   int perPage)
                                                                            throws GitLabApiException
        Get a list of the board’s lists for the specified project to using the specified page and per page setting. Does not include open and closed lists. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        page - the page to get
        perPage - the number of Boards per page
        Returns:
        a list of the issue board's lists in the specified range
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoardLists

        public Pager<org.gitlab4j.api.models.BoardList> getProjectIssueBoardLists​(java.lang.Object projectIdOrPath,
                                                                          java.lang.Long boardId,
                                                                          int itemsPerPage)
                                                                   throws GitLabApiException
        Get a Pager of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        itemsPerPage - the number of Board instances that will be fetched per page
        Returns:
        a Pager of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoardsListsStream

        public java.util.stream.Stream<org.gitlab4j.api.models.BoardList> getProjectIssueBoardsListsStream​(java.lang.Object projectIdOrPath,
                                                                                                   java.lang.Long boardId)
                                                                                            throws GitLabApiException
        Get a Stream of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        Returns:
        a Stream of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getProjectIssueBoardList

        public org.gitlab4j.api.models.BoardList getProjectIssueBoardList​(java.lang.Object projectIdOrPath,
                                                                  java.lang.Long boardId,
                                                                  java.lang.Long listId)
                                                           throws GitLabApiException
        Get a single issue board list. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists/:list_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        listId - the ID of the board lists to get
        Returns:
        a BoardList instance for the specified board ID and list ID
        Throws:
        GitLabApiException - if any exception occurs

      • getOptionalProjectIssueBoardList

        public java.util.Optional<org.gitlab4j.api.models.BoardList> getOptionalProjectIssueBoardList​(java.lang.Object projectIdOrPath,
                                                                                              java.lang.Long boardId,
                                                                                              java.lang.Long listId)
        Get a single issue board list as an Optional instance. 
        GitLab Endpoint: GET /projects/:id/boards/:board_id/lists/:list_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        listId - the ID of the board lists to get
        Returns:
        a BoardList instance for the specified board ID and list ID as an Optional instance

      • createProjectIssueBoardList

        public org.gitlab4j.api.models.BoardList createProjectIssueBoardList​(java.lang.Object projectIdOrPath,
                                                                     java.lang.Long boardId,
                                                                     java.lang.Long labelId,
                                                                     java.lang.Long assigneeId,
                                                                     java.lang.Long milestoneId,
                                                                     java.lang.Long iterationId)
                                                              throws GitLabApiException
        Creates a new Issue Board list. 
        GitLab Endpoint: POST /projects/:id/boards/:board_id/lists
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        labelId - the ID of the label, optional (can be null)
        assigneeId - The ID of a user. Premium and Ultimate only, optional (can be null)
        milestoneId - The ID of a milestone. Premium and Ultimate only, optional (can be null)
        iterationId - The ID of a milestone. Premium and Ultimate only, optional (can be null)
        Returns:
        the created BoardList instance
        Throws:
        GitLabApiException - if any exception occurs

      • updateProjectIssueBoardList

        public org.gitlab4j.api.models.BoardList updateProjectIssueBoardList​(java.lang.Object projectIdOrPath,
                                                                     java.lang.Long boardId,
                                                                     java.lang.Long listId,
                                                                     java.lang.Integer position)
                                                              throws GitLabApiException
        Updates an existing Issue Board list. This call is used to change list position. 
        GitLab Endpoint: PUT /projects/:id/boards/:board_id/lists/:list_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        listId - the ID of the list
        position - the new position for the list
        Returns:
        the updated BoardList instance
        Throws:
        GitLabApiException - if any exception occurs

      • deleteProjectIssueBoardList

        public void deleteProjectIssueBoardList​(java.lang.Object projectIdOrPath,
                                        java.lang.Long boardId,
                                        java.lang.Long listId)
                                 throws GitLabApiException
        Soft deletes an existing Issue Board list. Only for admins and project owners. 
        GitLab Endpoint: DELETE /projects/:id/boards/:board_id/lists/:list_id
        Parameters:
        projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance
        boardId - the ID of the board
        listId - the ID of the list
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoards

        public java.util.List<org.gitlab4j.api.models.Board> getGroupIssueBoards​(java.lang.Object groupIdOrPath)
                                                                  throws GitLabApiException
        Lists Issue Boards in the given group. 
        GitLab Endpoint: GET /groups/:id/boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        Returns:
        a list of group's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoards

        public java.util.List<org.gitlab4j.api.models.Board> getGroupIssueBoards​(java.lang.Object groupIdOrPath,
                                                                         int page,
                                                                         int perPage)
                                                                  throws GitLabApiException
        Get all issue boards for the specified group using the specified page and per page setting 
        GitLab Endpoint: GET /groups/:id/boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        page - the page to get
        perPage - the number of items per page
        Returns:
        a list of group's Boards in the specified range
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoards

        public Pager<org.gitlab4j.api.models.Board> getGroupIssueBoards​(java.lang.Object groupIdOrPath,
                                                                int itemsPerPage)
                                                         throws GitLabApiException
        Get a Pager of all issue boards for the specified group. 
        GitLab Endpoint: GET /groups/:id/boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        itemsPerPage - the number of items per page
        Returns:
        a Pager of group's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoardsStream

        public java.util.stream.Stream<org.gitlab4j.api.models.Board> getGroupIssueBoardsStream​(java.lang.Object groupIdOrPath)
                                                                                 throws GitLabApiException
        Get a Stream of all issue boards for the specified group. 
        GitLab Endpoint: GET /groups/:id/boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        Returns:
        a Stream of group's issue boards
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoard

        public org.gitlab4j.api.models.Board getGroupIssueBoard​(java.lang.Object groupIdOrPath,
                                                        java.lang.Long boardId)
                                                 throws GitLabApiException
        Get a single issue board. 
        GitLab Endpoint: GET /groups/:id/boards/:board_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Returns:
        a Board instance for the specified board ID
        Throws:
        GitLabApiException - if any exception occurs

      • getOptionalGroupIssueBoard

        public java.util.Optional<org.gitlab4j.api.models.Board> getOptionalGroupIssueBoard​(java.lang.Object groupIdOrPath,
                                                                                    java.lang.Long boardId)
        Get an issue board as an Optional instance. 
        GitLab Endpoint: GET /groups/:id/boards/:board_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Returns:
        the Board instance for the specified board ID as an Optional instance

      • createGroupIssueBoard

        public org.gitlab4j.api.models.Board createGroupIssueBoard​(java.lang.Object groupIdOrPath,
                                                           java.lang.String name)
                                                    throws GitLabApiException
        Creates a new Issue Board. 
        GitLab Endpoint: POST /groups/:id/boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        name - the name for the new board
        Returns:
        the created Board instance
        Throws:
        GitLabApiException - if any exception occurs

      • updateGroupIssueBoard

        public org.gitlab4j.api.models.Board updateGroupIssueBoard​(java.lang.Object groupIdOrPath,
                                                           java.lang.Long boardId,
                                                           java.lang.String name,
                                                           java.lang.Boolean hideBacklogList,
                                                           java.lang.Boolean hideClosedList,
                                                           java.lang.Long assigneeId,
                                                           java.lang.Long milestoneId,
                                                           java.lang.String labels,
                                                           java.lang.Integer weight)
                                                    throws GitLabApiException
        Updates an existing Issue Board. 
        GitLab Endpoint: PUT /groups/:id/boards/:board_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance, required
        boardId - the ID of the board, required
        name - the new name of the board, optional (can be null)
        hideBacklogList - hide the Open list, optional (can be null)
        hideClosedList - hide the Closed list, optional (can be null)
        assigneeId - the assignee the board should be scoped to, optional (can be null)
        milestoneId - the milestone the board should be scoped to, optional (can be null)
        labels - a comma-separated list of label names which the board should be scoped to, optional (can be null)
        weight - the weight range from 0 to 9, to which the board should be scoped to, optional (can be null)
        Returns:
        the updated Board instance
        Throws:
        GitLabApiException - if any exception occurs

      • deleteGroupIssueBoard

        public void deleteGroupIssueBoard​(java.lang.Object groupIdOrPath,
                                  java.lang.Long boardId)
                           throws GitLabApiException
        Soft deletes an existing Issue Board. 
        GitLab Endpoint: DELETE /groups/:id/boards/:board_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoardLists

        public java.util.List<org.gitlab4j.api.models.BoardList> getGroupIssueBoardLists​(java.lang.Object groupIdOrPath,
                                                                                 java.lang.Long boardId)
                                                                          throws GitLabApiException
        Get a list of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /groups/:id/boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Returns:
        a list of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoardLists

        public java.util.List<org.gitlab4j.api.models.BoardList> getGroupIssueBoardLists​(java.lang.Object groupIdOrPath,
                                                                                 java.lang.Long boardId,
                                                                                 int page,
                                                                                 int perPage)
                                                                          throws GitLabApiException
        Get a list of the board’s lists for the specified group to using the specified page and per page setting. Does not include open and closed lists. 
        GitLab Endpoint: GET /groups/:id/boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        page - the page to get
        perPage - the number of Boards per page
        Returns:
        a list of the issue board's lists in the specified range
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoardLists

        public Pager<org.gitlab4j.api.models.BoardList> getGroupIssueBoardLists​(java.lang.Object groupIdOrPath,
                                                                        java.lang.Long boardId,
                                                                        int itemsPerPage)
                                                                 throws GitLabApiException
        Get a Pager of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /groups/:id/boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        itemsPerPage - the number of Board instances that will be fetched per page
        Returns:
        a Pager of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoardsListsStream

        public java.util.stream.Stream<org.gitlab4j.api.models.BoardList> getGroupIssueBoardsListsStream​(java.lang.Object groupIdOrPath,
                                                                                                 java.lang.Long boardId)
                                                                                          throws GitLabApiException
        Get a Stream of the board’s lists. Does not include open and closed lists. 
        GitLab Endpoint: GET /groups/:id/boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Returns:
        a Stream of the issue board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupIssueBoardList

        public org.gitlab4j.api.models.BoardList getGroupIssueBoardList​(java.lang.Object groupIdOrPath,
                                                                java.lang.Long boardId,
                                                                java.lang.Long listId)
                                                         throws GitLabApiException
        Get a single issue board list. 
        GitLab Endpoint: GET /groups/:id/boards/:board_id/lists/:list_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        listId - the ID of the board lists to get
        Returns:
        a BoardList instance for the specified board ID and list ID
        Throws:
        GitLabApiException - if any exception occurs

      • getOptionalGroupIssueBoardList

        public java.util.Optional<org.gitlab4j.api.models.BoardList> getOptionalGroupIssueBoardList​(java.lang.Object groupIdOrPath,
                                                                                            java.lang.Long boardId,
                                                                                            java.lang.Long listId)
        Get a single issue board list as an Optional instance. 
        GitLab Endpoint: GET /groups/:id/boards/:board_id/lists/:list_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        listId - the ID of the board lists to get
        Returns:
        a BoardList instance for the specified board ID and list ID as an Optional instance

      • createGroupIssueBoardList

        public org.gitlab4j.api.models.BoardList createGroupIssueBoardList​(java.lang.Object groupIdOrPath,
                                                                   java.lang.Long boardId,
                                                                   java.lang.Long labelId,
                                                                   java.lang.Long assigneeId,
                                                                   java.lang.Long milestoneId,
                                                                   java.lang.Long iterationId)
                                                            throws GitLabApiException
        Creates a new Issue Board list. 
        GitLab Endpoint: POST /groups/:id/boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        labelId - the ID of the label
        assigneeId - The ID of a user. Premium and Ultimate only, optional (can be null)
        milestoneId - The ID of a milestone. Premium and Ultimate only, optional (can be null)
        iterationId - The ID of a milestone. Premium and Ultimate only, optional (can be null)
        Returns:
        the created BoardList instance
        Throws:
        GitLabApiException - if any exception occurs

      • updateGroupIssueBoardList

        public org.gitlab4j.api.models.BoardList updateGroupIssueBoardList​(java.lang.Object groupIdOrPath,
                                                                   java.lang.Long boardId,
                                                                   java.lang.Long listId,
                                                                   java.lang.Integer position)
                                                            throws GitLabApiException
        Updates an existing Issue Board list. This call is used to change list position. 
        GitLab Endpoint: PUT /groups/:id/boards/:board_id/lists/:list_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        listId - the ID of the list
        position - the new position for the list
        Returns:
        the updated BoardList instance
        Throws:
        GitLabApiException - if any exception occurs

      • deleteGroupIssueBoardList

        public void deleteGroupIssueBoardList​(java.lang.Object groupIdOrPath,
                                      java.lang.Long boardId,
                                      java.lang.Long listId)
                               throws GitLabApiException
        Soft deletes an existing Issue Board list. Only for admins and group owners. 
        GitLab Endpoint: DELETE /groups/:id/boards/:board_id/lists/:list_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        listId - the ID of the list
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoards

        public java.util.List<org.gitlab4j.api.models.Board> getGroupEpicBoards​(java.lang.Object groupIdOrPath)
                                                                 throws GitLabApiException
        Lists epic boards in the given group. 
        GitLab Endpoint: GET /groups/:id/epic_boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        Returns:
        a list of group's epic boards
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoards

        public java.util.List<org.gitlab4j.api.models.Board> getGroupEpicBoards​(java.lang.Object groupIdOrPath,
                                                                        int page,
                                                                        int perPage)
                                                                 throws GitLabApiException
        Get all epic boards for the specified group using the specified page and per page setting 
        GitLab Endpoint: GET /groups/:id/epic_boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        page - the page to get
        perPage - the number of items per page
        Returns:
        a list of group's Boards in the specified range
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoards

        public Pager<org.gitlab4j.api.models.Board> getGroupEpicBoards​(java.lang.Object groupIdOrPath,
                                                               int itemsPerPage)
                                                        throws GitLabApiException
        Get a Pager of all epic boards for the specified group. 
        GitLab Endpoint: GET /groups/:id/epic_boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        itemsPerPage - the number of items per page
        Returns:
        a Pager of group's epic boards
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoardsStream

        public java.util.stream.Stream<org.gitlab4j.api.models.Board> getGroupEpicBoardsStream​(java.lang.Object groupIdOrPath)
                                                                                throws GitLabApiException
        Get a Stream of all epic boards for the specified group. 
        GitLab Endpoint: GET /groups/:id/epic_boards
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        Returns:
        a Stream of group's epic boards
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoard

        public org.gitlab4j.api.models.Board getGroupEpicBoard​(java.lang.Object groupIdOrPath,
                                                       java.lang.Long boardId)
                                                throws GitLabApiException
        Get a single epic board. 
        GitLab Endpoint: GET /groups/:id/epic_boards/:board_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Returns:
        a Board instance for the specified board ID
        Throws:
        GitLabApiException - if any exception occurs

      • getOptionalGroupEpicBoard

        public java.util.Optional<org.gitlab4j.api.models.Board> getOptionalGroupEpicBoard​(java.lang.Object groupIdOrPath,
                                                                                   java.lang.Long boardId)
        Get an epic board as an Optional instance. 
        GitLab Endpoint: GET /groups/:id/epic_boards/:board_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Returns:
        the Board instance for the specified board ID as an Optional instance

      • getGroupEpicBoardLists

        public java.util.List<org.gitlab4j.api.models.BoardList> getGroupEpicBoardLists​(java.lang.Object groupIdOrPath,
                                                                                java.lang.Long boardId)
                                                                         throws GitLabApiException
        Get a list of the board’s lists. 
        GitLab Endpoint: GET /groups/:id/epic_boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Returns:
        a list of the epic board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoardLists

        public java.util.List<org.gitlab4j.api.models.BoardList> getGroupEpicBoardLists​(java.lang.Object groupIdOrPath,
                                                                                java.lang.Long boardId,
                                                                                int page,
                                                                                int perPage)
                                                                         throws GitLabApiException
        Get a list of the board’s lists for the specified group to using the specified page and per page setting. 
        GitLab Endpoint: GET /groups/:id/epic_boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        page - the page to get
        perPage - the number of Boards per page
        Returns:
        a list of the epic board's lists in the specified range
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoardLists

        public Pager<org.gitlab4j.api.models.BoardList> getGroupEpicBoardLists​(java.lang.Object groupIdOrPath,
                                                                       java.lang.Long boardId,
                                                                       int itemsPerPage)
                                                                throws GitLabApiException
        Get a Pager of the board’s lists. 
        GitLab Endpoint: GET /groups/:id/epic_boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        itemsPerPage - the number of Board instances that will be fetched per page
        Returns:
        a Pager of the epic board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoardsListsStream

        public java.util.stream.Stream<org.gitlab4j.api.models.BoardList> getGroupEpicBoardsListsStream​(java.lang.Object groupIdOrPath,
                                                                                                java.lang.Long boardId)
                                                                                         throws GitLabApiException
        Get a Stream of the board’s lists. 
        GitLab Endpoint: GET /groups/:id/epic_boards/:board_id/lists
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        Returns:
        a Stream of the epic board's lists
        Throws:
        GitLabApiException - if any exception occurs

      • getGroupEpicBoardList

        public org.gitlab4j.api.models.BoardList getGroupEpicBoardList​(java.lang.Object groupIdOrPath,
                                                               java.lang.Long boardId,
                                                               java.lang.Long listId)
                                                        throws GitLabApiException
        Get a single epic board list. 
        GitLab Endpoint: GET /groups/:id/epic_boards/:board_id/lists/:list_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        listId - the ID of the board lists to get
        Returns:
        a BoardList instance for the specified board ID and list ID
        Throws:
        GitLabApiException - if any exception occurs

      • getOptionalGroupEpicBoardList

        public java.util.Optional<org.gitlab4j.api.models.BoardList> getOptionalGroupEpicBoardList​(java.lang.Object groupIdOrPath,
                                                                                           java.lang.Long boardId,
                                                                                           java.lang.Long listId)
        Get a single epic board list as an Optional instance. 
        GitLab Endpoint: GET /groups/:id/epic_boards/:board_id/lists/:list_id
        Parameters:
        groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance
        boardId - the ID of the board
        listId - the ID of the board lists to get
        Returns:
        a BoardList instance for the specified board ID and list ID as an Optional instance