Module bus.gitlab
Package org.miaixz.bus.gitlab

Class BoardsApi

java.lang.Object
org.miaixz.bus.gitlab.AbstractApi
org.miaixz.bus.gitlab.BoardsApi
All Implemented Interfaces:
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:

  • Constructor Details

    • BoardsApi

      public BoardsApi(GitLabApi gitLabApi)

  • Method Details

    • getProjectIssueBoards

      public List<Board> getProjectIssueBoards(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 List<Board> getProjectIssueBoards(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<Board> getProjectIssueBoards(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 Stream<Board> getProjectIssueBoardsStream(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 Board getProjectIssueBoard(Object projectIdOrPath, 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 Optional<Board> getOptionalProjectIssueBoard(Object projectIdOrPath, 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 Board createProjectIssueBoard(Object projectIdOrPath, 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 Board updateProjectIssueBoard(Object projectIdOrPath, Long boardId, String name, Boolean hideBacklogList, Boolean hideClosedList, Long assigneeId, Long milestoneId, String labels, 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(Object projectIdOrPath, 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 List<BoardList> getProjectIssueBoardLists(Object projectIdOrPath, 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 List<BoardList> getProjectIssueBoardLists(Object projectIdOrPath, 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<BoardList> getProjectIssueBoardLists(Object projectIdOrPath, 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 Stream<BoardList> getProjectIssueBoardsListsStream(Object projectIdOrPath, 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 BoardList getProjectIssueBoardList(Object projectIdOrPath, Long boardId, 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 Optional<BoardList> getOptionalProjectIssueBoardList(Object projectIdOrPath, Long boardId, 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 BoardList createProjectIssueBoardList(Object projectIdOrPath, Long boardId, Long labelId, Long assigneeId, Long milestoneId, 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 BoardList updateProjectIssueBoardList(Object projectIdOrPath, Long boardId, Long listId, 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(Object projectIdOrPath, Long boardId, 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 List<Board> getGroupIssueBoards(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 List<Board> getGroupIssueBoards(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<Board> getGroupIssueBoards(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 Stream<Board> getGroupIssueBoardsStream(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 Board getGroupIssueBoard(Object groupIdOrPath, 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 Optional<Board> getOptionalGroupIssueBoard(Object groupIdOrPath, 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 Board createGroupIssueBoard(Object groupIdOrPath, 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 Board updateGroupIssueBoard(Object groupIdOrPath, Long boardId, String name, Boolean hideBacklogList, Boolean hideClosedList, Long assigneeId, Long milestoneId, String labels, 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(Object groupIdOrPath, 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 List<BoardList> getGroupIssueBoardLists(Object groupIdOrPath, 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 List<BoardList> getGroupIssueBoardLists(Object groupIdOrPath, 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<BoardList> getGroupIssueBoardLists(Object groupIdOrPath, 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 Stream<BoardList> getGroupIssueBoardsListsStream(Object groupIdOrPath, 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 BoardList getGroupIssueBoardList(Object groupIdOrPath, Long boardId, 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 Optional<BoardList> getOptionalGroupIssueBoardList(Object groupIdOrPath, Long boardId, 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 BoardList createGroupIssueBoardList(Object groupIdOrPath, Long boardId, Long labelId, Long assigneeId, Long milestoneId, 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 BoardList updateGroupIssueBoardList(Object groupIdOrPath, Long boardId, Long listId, 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(Object groupIdOrPath, Long boardId, 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 List<Board> getGroupEpicBoards(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 List<Board> getGroupEpicBoards(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<Board> getGroupEpicBoards(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 Stream<Board> getGroupEpicBoardsStream(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 Board getGroupEpicBoard(Object groupIdOrPath, 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 Optional<Board> getOptionalGroupEpicBoard(Object groupIdOrPath, 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 List<BoardList> getGroupEpicBoardLists(Object groupIdOrPath, 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 List<BoardList> getGroupEpicBoardLists(Object groupIdOrPath, 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<BoardList> getGroupEpicBoardLists(Object groupIdOrPath, 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 Stream<BoardList> getGroupEpicBoardsListsStream(Object groupIdOrPath, 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 BoardList getGroupEpicBoardList(Object groupIdOrPath, Long boardId, 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 Optional<BoardList> getOptionalGroupEpicBoardList(Object groupIdOrPath, Long boardId, 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