Package org.gitlab4j.api
Class NotesApi
java.lang.Object
org.gitlab4j.api.AbstractApi
org.gitlab4j.api.NotesApi
- All Implemented Interfaces:
Constants
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants
Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType
-
Field Summary
Fields inherited from class org.gitlab4j.api.AbstractApi
gitLabApi
Fields inherited from interface org.gitlab4j.api.Constants
NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreateIssueNote
(Object projectIdOrPath, Long issueIid, String body) Create a issues's note.createIssueNote
(Object projectIdOrPath, Long issueIid, String body, Date createdAt) Create a issues's note.createMergeRequestNote
(Object projectIdOrPath, Long mergeRequestIid, String body) Create a merge request's note.void
deleteIssueNote
(Object projectIdOrPath, Long issueIid, Long noteId) Delete the specified issues's note.void
deleteMergeRequestNote
(Object projectIdOrPath, Long mergeRequestIid, Long noteId) Delete the specified merge request's note.getIssueNote
(Object projectIdOrPath, Long issueIid, Long noteId) Get the specified issues's note.getIssueNotes
(Object projectIdOrPath, Long issueIid) Get a list of the issues's notes.getIssueNotes
(Object projectIdOrPath, Long issueIid, int itemsPerPage) Get a Pager of issues's notes.getIssueNotes
(Object projectIdOrPath, Long issueIid, int page, int perPage) Get a list of the issue's notes using the specified page and per page settings.getIssueNotesStream
(Object projectIdOrPath, Long issueIid) Get a Stream of the issues's notes.getMergeRequestNote
(Object projectIdOrPath, Long mergeRequestIid, Long noteId) Get the specified merge request's note.getMergeRequestNotes
(Object projectIdOrPath, Long mergeRequestIid) Gets a list of all notes for a single merge requestgetMergeRequestNotes
(Object projectIdOrPath, Long mergeRequestIid, int itemsPerPage) Get a Pager of all notes for a single merge requestgetMergeRequestNotes
(Object projectIdOrPath, Long mergeRequestIid, int page, int perPage) Gets a list of all notes for a single merge request using the specified page and per page settings.getMergeRequestNotes
(Object projectIdOrPath, Long mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy) Gets a list of all notes for a single merge request.getMergeRequestNotes
(Object projectIdOrPath, Long mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy, int itemsPerPage) Get a Pager of all notes for a single merge requestgetMergeRequestNotes
(Object projectIdOrPath, Long mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy, int page, int perPage) Gets a list of all notes for a single merge request using the specified page and per page settings.getMergeRequestNotesStream
(Object projectIdOrPath, Long mergeRequestIid) Gets a Stream of all notes for a single merge requestgetMergeRequestNotesStream
(Object projectIdOrPath, Long mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy) Gets a Stream of all notes for a single merge request.Deprecated.Deprecated.As of release 4.7.0, replaced bygetIssueNotes(Object, Long, int)
Deprecated.As of release 4.7.0, replaced bygetIssueNotes(Object, Long, int, int)
updateIssueNote
(Object projectIdOrPath, Long issueIid, Long noteId, String body) Update the specified issues's note.updateMergeRequestNote
(Object projectIdOrPath, Long mergeRequestIid, Long noteId, String body) Update the specified merge request's note.Methods inherited from class org.gitlab4j.api.AbstractApi
addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate
-
Constructor Details
-
NotesApi
-
-
Method Details
-
getNotes
@Deprecated public List<Note> getNotes(Object projectIdOrPath, Long issueIid) throws GitLabApiException Deprecated.As of release 4.7.0, replaced bygetIssueNotes(Object, Long)
Get a list of the issues's notes.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue ID to get the notes for- Returns:
- a list of the issues's notes
- Throws:
GitLabApiException
- if any exception occurs
-
getNotes
@Deprecated public List<Note> getNotes(Object projectIdOrPath, Long issueIid, int page, int perPage) throws GitLabApiException Deprecated.As of release 4.7.0, replaced bygetIssueNotes(Object, Long, int, int)
Get a list of the issue's notes using the specified page and per page settings.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue IID to get the notes forpage
- the page to getperPage
- the number of notes per page- Returns:
- the list of notes in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getNotes
@Deprecated public Pager<Note> getNotes(Object projectIdOrPath, Long issueIid, int itemsPerPage) throws GitLabApiException Deprecated.As of release 4.7.0, replaced bygetIssueNotes(Object, Long, int)
Get a Pager of issues's notes.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue IID to get the notes foritemsPerPage
- the number of notes per page- Returns:
- the list of notes in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getIssueNotes
Get a list of the issues's notes.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue ID to get the notes for- Returns:
- a list of the issues's notes
- Throws:
GitLabApiException
- if any exception occurs
-
getIssueNotes
public List<Note> getIssueNotes(Object projectIdOrPath, Long issueIid, int page, int perPage) throws GitLabApiException Get a list of the issue's notes using the specified page and per page settings.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue IID to get the notes forpage
- the page to getperPage
- the number of notes per page- Returns:
- the list of notes in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getIssueNotes
public Pager<Note> getIssueNotes(Object projectIdOrPath, Long issueIid, int itemsPerPage) throws GitLabApiException Get a Pager of issues's notes.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue IID to get the notes foritemsPerPage
- the number of notes per page- Returns:
- the list of notes in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getIssueNotesStream
public Stream<Note> getIssueNotesStream(Object projectIdOrPath, Long issueIid) throws GitLabApiException Get a Stream of the issues's notes.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue ID to get the notes for- Returns:
- a Stream of the issues's notes
- Throws:
GitLabApiException
- if any exception occurs
-
getIssueNote
public Note getIssueNote(Object projectIdOrPath, Long issueIid, Long noteId) throws GitLabApiException Get the specified issues's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue IID to get the notes fornoteId
- the ID of the Note to get- Returns:
- a Note instance for the specified IDs
- Throws:
GitLabApiException
- if any exception occurs
-
createIssueNote
public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body) throws GitLabApiException Create a issues's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instance @param projectIdOrPath the project ID to create the issues forissueIid
- the issue IID to create the notes forbody
- the content of note- Returns:
- the created Note instance
- Throws:
GitLabApiException
- if any exception occurs
-
createIssueNote
public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body, Date createdAt) throws GitLabApiException Create a issues's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue IID to create the notes forbody
- the content of notecreatedAt
- the created time of note- Returns:
- the created Note instance
- Throws:
GitLabApiException
- if any exception occurs
-
updateIssueNote
public Note updateIssueNote(Object projectIdOrPath, Long issueIid, Long noteId, String body) throws GitLabApiException Update the specified issues's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue IID to update the notes fornoteId
- the ID of the node to updatebody
- the update content for the Note- Returns:
- the modified Note instance
- Throws:
GitLabApiException
- if any exception occurs
-
deleteIssueNote
public void deleteIssueNote(Object projectIdOrPath, Long issueIid, Long noteId) throws GitLabApiException Delete the specified issues's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instanceissueIid
- the issue IID to delete the notes fornoteId
- the ID of the node to delete- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNotes
public List<Note> getMergeRequestNotes(Object projectIdOrPath, Long mergeRequestIid) throws GitLabApiException Gets a list of all notes for a single merge requestGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the issue ID to get the notes for- Returns:
- a list of the merge request's notes
- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNotes
public List<Note> getMergeRequestNotes(Object projectIdOrPath, Long mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy) throws GitLabApiException Gets a list of all notes for a single merge request.GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the issue ID to get the notes forsortOrder
- return merge request notes sorted in the specified sort order, default is DESCorderBy
- return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_AT- Returns:
- a list of the merge request's notes
- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNotes
public List<Note> getMergeRequestNotes(Object projectIdOrPath, Long mergeRequestIid, int page, int perPage) throws GitLabApiException Gets a list of all notes for a single merge request using the specified page and per page settings.GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the merge request IID to get the notes forpage
- the page to getperPage
- the number of notes per page- Returns:
- the list of notes in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNotes
public List<Note> getMergeRequestNotes(Object projectIdOrPath, Long mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy, int page, int perPage) throws GitLabApiException Gets a list of all notes for a single merge request using the specified page and per page settings.GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the merge request IID to get the notes forsortOrder
- return merge request notes sorted in the specified sort order, default is DESCorderBy
- return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_ATpage
- the page to getperPage
- the number of notes per page- Returns:
- the list of notes in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNotes
public Pager<Note> getMergeRequestNotes(Object projectIdOrPath, Long mergeRequestIid, int itemsPerPage) throws GitLabApiException Get a Pager of all notes for a single merge requestGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the merge request IID to get the notes foritemsPerPage
- the number of notes per page- Returns:
- the list of notes in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNotesStream
public Stream<Note> getMergeRequestNotesStream(Object projectIdOrPath, Long mergeRequestIid) throws GitLabApiException Gets a Stream of all notes for a single merge requestGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the issue ID to get the notes for- Returns:
- a Stream of the merge request's notes
- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNotes
public Pager<Note> getMergeRequestNotes(Object projectIdOrPath, Long mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy, int itemsPerPage) throws GitLabApiException Get a Pager of all notes for a single merge requestGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the merge request IID to get the notes forsortOrder
- return merge request notes sorted in the specified sort order, default is DESCorderBy
- return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_ATitemsPerPage
- the number of notes per page- Returns:
- the list of notes in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNotesStream
public Stream<Note> getMergeRequestNotesStream(Object projectIdOrPath, Long mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy) throws GitLabApiException Gets a Stream of all notes for a single merge request.GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes
- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the issue ID to get the notes forsortOrder
- return merge request notes sorted in the specified sort order, default is DESCorderBy
- return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_AT- Returns:
- a Stream of the merge request's notes
- Throws:
GitLabApiException
- if any exception occurs
-
getMergeRequestNote
public Note getMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid, Long noteId) throws GitLabApiException Get the specified merge request's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the merge request IID to get the notes fornoteId
- the ID of the Note to get- Returns:
- a Note instance for the specified IDs
- Throws:
GitLabApiException
- if any exception occurs
-
createMergeRequestNote
public Note createMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid, String body) throws GitLabApiException Create a merge request's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the merge request IID to create the notes forbody
- the content of note- Returns:
- the created Note instance
- Throws:
GitLabApiException
- if any exception occurs
-
updateMergeRequestNote
public Note updateMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid, Long noteId, String body) throws GitLabApiException Update the specified merge request's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the merge request IID to update the notes fornoteId
- the ID of the node to updatebody
- the update content for the Note- Returns:
- the modified Note instance
- Throws:
GitLabApiException
- if any exception occurs
-
deleteMergeRequestNote
public void deleteMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid, Long noteId) throws GitLabApiException Delete the specified merge request's note.- Parameters:
projectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instancemergeRequestIid
- the merge request IID to delete the notes fornoteId
- the ID of the node to delete- Throws:
GitLabApiException
- if any exception occurs
-
getIssueNotes(Object, Long)