java.lang.Object
- org.gitlab4j.api.AbstractApi
- - org.gitlab4j.api.NotesApi

All Implemented Interfaces:

org.gitlab4j.models.Constants
```
public class NotesApi
extends AbstractApi
```

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.AutoCancelPendingPipelines, 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.ProjectFeatureVisibilityAccessLevel, 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 class org.gitlab4j.api.AbstractApi
  gitLabApi
- 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

NotesApi(GitLabApi gitLabApi)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.gitlab4j.api.models.Note`	`createEpicNote(java.lang.Object groupIdOrPath, java.lang.Long epicId, java.lang.String body)`	Create a epics's note.
`org.gitlab4j.api.models.Note`	`createEpicNote(java.lang.Object groupIdOrPath, java.lang.Long epicId, java.lang.String body, java.util.Date createdAt)`	Create a epics's note.
`org.gitlab4j.api.models.Note`	`createEpicNote(java.lang.Object groupIdOrPath, java.lang.Long epicId, java.lang.String body, java.util.Date createdAt, java.lang.Boolean internal)`	Create a epics's note.
`org.gitlab4j.api.models.Note`	`createIssueNote(java.lang.Object projectIdOrPath, java.lang.Long issueIid, java.lang.String body)`	Create a issues's note.
`org.gitlab4j.api.models.Note`	`createIssueNote(java.lang.Object projectIdOrPath, java.lang.Long issueIid, java.lang.String body, java.util.Date createdAt)`	Create a issues's note.
`org.gitlab4j.api.models.Note`	`createIssueNote(java.lang.Object projectIdOrPath, java.lang.Long issueIid, java.lang.String body, java.util.Date createdAt, java.lang.Boolean internal)`	Create a issues's note.
`org.gitlab4j.api.models.Note`	`createMergeRequestNote(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, java.lang.String body, java.util.Date createdAt, java.lang.Boolean internal)`	Create a merge request's note.
`void`	`deleteEpicNote(java.lang.Object groupIdOrPath, java.lang.Long epicId, java.lang.Long noteId)`	Delete the specified epics's note.
`void`	`deleteIssueNote(java.lang.Object projectIdOrPath, java.lang.Long issueIid, java.lang.Long noteId)`	Delete the specified issues's note.
`void`	`deleteMergeRequestNote(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, java.lang.Long noteId)`	Delete the specified merge request's note.
`org.gitlab4j.api.models.Note`	`getEpicNote(java.lang.Object groupIdOrPath, java.lang.Long epicId, java.lang.Long noteId)`	Get the specified epics's note.
`java.util.List<org.gitlab4j.api.models.Note>`	`getEpicNotes(java.lang.Object groupIdOrPath, java.lang.Long epicId)`	Get a list of the epics's notes.
`Pager<org.gitlab4j.api.models.Note>`	`getEpicNotes(java.lang.Object groupIdOrPath, java.lang.Long epicId, int itemsPerPage)`	Get a Pager of epics's notes.
`java.util.List<org.gitlab4j.api.models.Note>`	`getEpicNotes(java.lang.Object groupIdOrPath, java.lang.Long epicId, int page, int perPage)`	Get a list of the epic's notes using the specified page and per page settings.
`java.util.stream.Stream<org.gitlab4j.api.models.Note>`	`getEpicNotesStream(java.lang.Object groupIdOrPath, java.lang.Long epicId)`	Get a Stream of the epics's notes.
`org.gitlab4j.api.models.Note`	`getIssueNote(java.lang.Object projectIdOrPath, java.lang.Long issueIid, java.lang.Long noteId)`	Get the specified issues's note.
`java.util.List<org.gitlab4j.api.models.Note>`	`getIssueNotes(java.lang.Object projectIdOrPath, java.lang.Long issueIid)`	Get a list of the issues's notes.
`Pager<org.gitlab4j.api.models.Note>`	`getIssueNotes(java.lang.Object projectIdOrPath, java.lang.Long issueIid, int itemsPerPage)`	Get a Pager of issues's notes.
`java.util.List<org.gitlab4j.api.models.Note>`	`getIssueNotes(java.lang.Object projectIdOrPath, java.lang.Long issueIid, int page, int perPage)`	Get a list of the issue's notes using the specified page and per page settings.
`java.util.stream.Stream<org.gitlab4j.api.models.Note>`	`getIssueNotesStream(java.lang.Object projectIdOrPath, java.lang.Long issueIid)`	Get a Stream of the issues's notes.
`org.gitlab4j.api.models.Note`	`getMergeRequestNote(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, java.lang.Long noteId)`	Get the specified merge request's note.
`java.util.List<org.gitlab4j.api.models.Note>`	`getMergeRequestNotes(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid)`	Gets a list of all notes for a single merge request
`Pager<org.gitlab4j.api.models.Note>`	`getMergeRequestNotes(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, int itemsPerPage)`	Get a Pager of all notes for a single merge request
`java.util.List<org.gitlab4j.api.models.Note>`	`getMergeRequestNotes(java.lang.Object projectIdOrPath, java.lang.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.
`java.util.List<org.gitlab4j.api.models.Note>`	`getMergeRequestNotes(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, org.gitlab4j.models.Constants.SortOrder sortOrder, org.gitlab4j.api.models.Note.OrderBy orderBy)`	Gets a list of all notes for a single merge request.
`Pager<org.gitlab4j.api.models.Note>`	`getMergeRequestNotes(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, org.gitlab4j.models.Constants.SortOrder sortOrder, org.gitlab4j.api.models.Note.OrderBy orderBy, int itemsPerPage)`	Get a Pager of all notes for a single merge request
`java.util.List<org.gitlab4j.api.models.Note>`	`getMergeRequestNotes(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, org.gitlab4j.models.Constants.SortOrder sortOrder, org.gitlab4j.api.models.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.
`java.util.stream.Stream<org.gitlab4j.api.models.Note>`	`getMergeRequestNotesStream(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid)`	Gets a Stream of all notes for a single merge request
`java.util.stream.Stream<org.gitlab4j.api.models.Note>`	`getMergeRequestNotesStream(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, org.gitlab4j.models.Constants.SortOrder sortOrder, org.gitlab4j.api.models.Note.OrderBy orderBy)`	Gets a Stream of all notes for a single merge request.
`org.gitlab4j.api.models.Note`	`updateEpicNote(java.lang.Object groupIdOrPath, java.lang.Long epicId, java.lang.Long noteId, java.lang.String body)`	Update the specified epics's note.
`org.gitlab4j.api.models.Note`	`updateIssueNote(java.lang.Object projectIdOrPath, java.lang.Long issueIid, java.lang.Long noteId, java.lang.String body)`	Update the specified issues's note.
`org.gitlab4j.api.models.Note`	`updateMergeRequestNote(java.lang.Object projectIdOrPath, java.lang.Long mergeRequestIid, java.lang.Long noteId, java.lang.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, getNamespaceIdOrPath, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, putWithFormData, upload, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotesApi

public NotesApi(GitLabApi gitLabApi)

Method Detail

getIssueNotes

public java.util.List<org.gitlab4j.api.models.Note> getIssueNotes(java.lang.Object projectIdOrPath,
                                                                  java.lang.Long issueIid)
                                                           throws GitLabApiException

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 instance; issueIid - the issue ID to get the notes for
Returns:: a list of the issues's notes
Throws:: GitLabApiException - if any exception occurs

getIssueNotes

public java.util.List<org.gitlab4j.api.models.Note> getIssueNotes(java.lang.Object projectIdOrPath,
                                                                  java.lang.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 instance; issueIid - the issue IID to get the notes for; page - the page to get; perPage - the number of notes per page
Returns:: the list of notes in the specified range
Throws:: GitLabApiException - if any exception occurs

getIssueNotes

public Pager<org.gitlab4j.api.models.Note> getIssueNotes(java.lang.Object projectIdOrPath,
                                                         java.lang.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 instance; issueIid - the issue IID to get the notes for; itemsPerPage - the number of notes per page
Returns:: the list of notes in the specified range
Throws:: GitLabApiException - if any exception occurs

getIssueNotesStream

public java.util.stream.Stream<org.gitlab4j.api.models.Note> getIssueNotesStream(java.lang.Object projectIdOrPath,
                                                                                 java.lang.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 instance; issueIid - the issue ID to get the notes for
Returns:: a Stream of the issues's notes
Throws:: GitLabApiException - if any exception occurs

getIssueNote

public org.gitlab4j.api.models.Note getIssueNote(java.lang.Object projectIdOrPath,
                                                 java.lang.Long issueIid,
                                                 java.lang.Long noteId)
                                          throws GitLabApiException

Get the specified issues's note.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; issueIid - the issue IID to get the notes for; noteId - the ID of the Note to get
Returns:: a Note instance for the specified IDs
Throws:: GitLabApiException - if any exception occurs

createIssueNote

public org.gitlab4j.api.models.Note createIssueNote(java.lang.Object projectIdOrPath,
                                                    java.lang.Long issueIid,
                                                    java.lang.String body)
                                             throws GitLabApiException

Create a issues's note.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id

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 for; issueIid - the issue IID to create the notes for; body - the content of note
Returns:: the created Note instance
Throws:: GitLabApiException - if any exception occurs

createIssueNote

public org.gitlab4j.api.models.Note createIssueNote(java.lang.Object projectIdOrPath,
                                                    java.lang.Long issueIid,
                                                    java.lang.String body,
                                                    java.util.Date createdAt)
                                             throws GitLabApiException

Create a issues's note.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; issueIid - the issue IID to create the notes for; body - the content of note; createdAt - the created time of note
Returns:: the created Note instance
Throws:: GitLabApiException - if any exception occurs

createIssueNote

public org.gitlab4j.api.models.Note createIssueNote(java.lang.Object projectIdOrPath,
                                                    java.lang.Long issueIid,
                                                    java.lang.String body,
                                                    java.util.Date createdAt,
                                                    java.lang.Boolean internal)
                                             throws GitLabApiException

Create a issues's note.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; issueIid - the issue IID to create the notes for; body - the content of note; createdAt - the created time of note; internal - whether the note shall be marked 'internal'
Returns:: the created Note instance
Throws:: GitLabApiException - if any exception occurs

updateIssueNote

public org.gitlab4j.api.models.Note updateIssueNote(java.lang.Object projectIdOrPath,
                                                    java.lang.Long issueIid,
                                                    java.lang.Long noteId,
                                                    java.lang.String body)
                                             throws GitLabApiException

Update the specified issues's note.

GitLab Endpoint: PUT /projects/:id/issues/:issue_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; issueIid - the issue IID to update the notes for; noteId - the ID of the node to update; body - the update content for the Note
Returns:: the modified Note instance
Throws:: GitLabApiException - if any exception occurs

deleteIssueNote

public void deleteIssueNote(java.lang.Object projectIdOrPath,
                            java.lang.Long issueIid,
                            java.lang.Long noteId)
                     throws GitLabApiException

Delete the specified issues's note.

GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; issueIid - the issue IID to delete the notes for; noteId - the ID of the node to delete
Throws:: GitLabApiException - if any exception occurs

getMergeRequestNotes

public java.util.List<org.gitlab4j.api.models.Note> getMergeRequestNotes(java.lang.Object projectIdOrPath,
                                                                         java.lang.Long mergeRequestIid)
                                                                  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 instance; mergeRequestIid - 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 java.util.List<org.gitlab4j.api.models.Note> getMergeRequestNotes(java.lang.Object projectIdOrPath,
                                                                         java.lang.Long mergeRequestIid,
                                                                         org.gitlab4j.models.Constants.SortOrder sortOrder,
                                                                         org.gitlab4j.api.models.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 instance; mergeRequestIid - the issue ID to get the notes for; sortOrder - return merge request notes sorted in the specified sort order, default is DESC; orderBy - 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 java.util.List<org.gitlab4j.api.models.Note> getMergeRequestNotes(java.lang.Object projectIdOrPath,
                                                                         java.lang.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 instance; mergeRequestIid - the merge request IID to get the notes for; page - the page to get; perPage - the number of notes per page
Returns:: the list of notes in the specified range
Throws:: GitLabApiException - if any exception occurs

getMergeRequestNotes

public java.util.List<org.gitlab4j.api.models.Note> getMergeRequestNotes(java.lang.Object projectIdOrPath,
                                                                         java.lang.Long mergeRequestIid,
                                                                         org.gitlab4j.models.Constants.SortOrder sortOrder,
                                                                         org.gitlab4j.api.models.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 instance; mergeRequestIid - the merge request IID to get the notes for; sortOrder - return merge request notes sorted in the specified sort order, default is DESC; orderBy - return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_AT; page - the page to get; perPage - the number of notes per page
Returns:: the list of notes in the specified range
Throws:: GitLabApiException - if any exception occurs

getMergeRequestNotes

public Pager<org.gitlab4j.api.models.Note> getMergeRequestNotes(java.lang.Object projectIdOrPath,
                                                                java.lang.Long mergeRequestIid,
                                                                int itemsPerPage)
                                                         throws GitLabApiException

Get a Pager 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 instance; mergeRequestIid - the merge request IID to get the notes for; itemsPerPage - the number of notes per page
Returns:: the list of notes in the specified range
Throws:: GitLabApiException - if any exception occurs

getMergeRequestNotesStream

public java.util.stream.Stream<org.gitlab4j.api.models.Note> getMergeRequestNotesStream(java.lang.Object projectIdOrPath,
                                                                                        java.lang.Long mergeRequestIid)
                                                                                 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 instance; mergeRequestIid - 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<org.gitlab4j.api.models.Note> getMergeRequestNotes(java.lang.Object projectIdOrPath,
                                                                java.lang.Long mergeRequestIid,
                                                                org.gitlab4j.models.Constants.SortOrder sortOrder,
                                                                org.gitlab4j.api.models.Note.OrderBy orderBy,
                                                                int itemsPerPage)
                                                         throws GitLabApiException

Get a Pager 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 instance; mergeRequestIid - the merge request IID to get the notes for; sortOrder - return merge request notes sorted in the specified sort order, default is DESC; orderBy - return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_AT; itemsPerPage - the number of notes per page
Returns:: the list of notes in the specified range
Throws:: GitLabApiException - if any exception occurs

getMergeRequestNotesStream

public java.util.stream.Stream<org.gitlab4j.api.models.Note> getMergeRequestNotesStream(java.lang.Object projectIdOrPath,
                                                                                        java.lang.Long mergeRequestIid,
                                                                                        org.gitlab4j.models.Constants.SortOrder sortOrder,
                                                                                        org.gitlab4j.api.models.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 instance; mergeRequestIid - the issue ID to get the notes for; sortOrder - return merge request notes sorted in the specified sort order, default is DESC; orderBy - 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 org.gitlab4j.api.models.Note getMergeRequestNote(java.lang.Object projectIdOrPath,
                                                        java.lang.Long mergeRequestIid,
                                                        java.lang.Long noteId)
                                                 throws GitLabApiException

Get the specified merge request's note.

GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; mergeRequestIid - the merge request IID to get the notes for; noteId - the ID of the Note to get
Returns:: a Note instance for the specified IDs
Throws:: GitLabApiException - if any exception occurs

createMergeRequestNote

public org.gitlab4j.api.models.Note createMergeRequestNote(java.lang.Object projectIdOrPath,
                                                           java.lang.Long mergeRequestIid,
                                                           java.lang.String body,
                                                           java.util.Date createdAt,
                                                           java.lang.Boolean internal)
                                                    throws GitLabApiException

Create a merge request's note.

GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; mergeRequestIid - the merge request IID to create the notes for; body - the content of note; createdAt - date the discussion was created (requires admin or project/group owner rights) (Optional)
Returns:: the created Note instance
Throws:: GitLabApiException - if any exception occurs

updateMergeRequestNote

public org.gitlab4j.api.models.Note updateMergeRequestNote(java.lang.Object projectIdOrPath,
                                                           java.lang.Long mergeRequestIid,
                                                           java.lang.Long noteId,
                                                           java.lang.String body)
                                                    throws GitLabApiException

Update the specified merge request's note.

GitLab Endpoint: PUT /projects/:id/merge_requests/:merge_request_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; mergeRequestIid - the merge request IID to update the notes for; noteId - the ID of the node to update; body - the update content for the Note
Returns:: the modified Note instance
Throws:: GitLabApiException - if any exception occurs

deleteMergeRequestNote

public void deleteMergeRequestNote(java.lang.Object projectIdOrPath,
                                   java.lang.Long mergeRequestIid,
                                   java.lang.Long noteId)
                            throws GitLabApiException

Delete the specified merge request's note.

GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id

Parameters:: projectIdOrPath - the project in the form of an Long(ID), String(path), or Project instance; mergeRequestIid - the merge request IID to delete the notes for; noteId - the ID of the node to delete
Throws:: GitLabApiException - if any exception occurs

getEpicNotes

public java.util.List<org.gitlab4j.api.models.Note> getEpicNotes(java.lang.Object groupIdOrPath,
                                                                 java.lang.Long epicId)
                                                          throws GitLabApiException

Get a list of the epics's notes.

GitLab Endpoint: GET /groups/:id/epics/:epic_id/notes

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance; epicId - the epic ID (not the IID!) to get the notes for
Returns:: a list of the epics's notes
Throws:: GitLabApiException - if any exception occurs

getEpicNotes

public java.util.List<org.gitlab4j.api.models.Note> getEpicNotes(java.lang.Object groupIdOrPath,
                                                                 java.lang.Long epicId,
                                                                 int page,
                                                                 int perPage)
                                                          throws GitLabApiException

Get a list of the epic's notes using the specified page and per page settings.

GitLab Endpoint: GET /groups/:id/epics/:epic_id/notes

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance; epicId - the epic ID (not the IID!) to get the notes for; page - the page to get; perPage - the number of notes per page
Returns:: the list of notes in the specified range
Throws:: GitLabApiException - if any exception occurs

getEpicNotes

public Pager<org.gitlab4j.api.models.Note> getEpicNotes(java.lang.Object groupIdOrPath,
                                                        java.lang.Long epicId,
                                                        int itemsPerPage)
                                                 throws GitLabApiException

Get a Pager of epics's notes.

GitLab Endpoint: GET /groups/:id/epics/:epic_id/notes

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance; epicId - the epic ID (not the IID!) to get the notes for; itemsPerPage - the number of notes per page
Returns:: the list of notes in the specified range
Throws:: GitLabApiException - if any exception occurs

getEpicNotesStream

public java.util.stream.Stream<org.gitlab4j.api.models.Note> getEpicNotesStream(java.lang.Object groupIdOrPath,
                                                                                java.lang.Long epicId)
                                                                         throws GitLabApiException

Get a Stream of the epics's notes.

GitLab Endpoint: GET /groups/:id/epics/:epic_id/notes

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance; epicId - the epic ID (not the IID!) to get the notes for
Returns:: a Stream of the epics's notes
Throws:: GitLabApiException - if any exception occurs

getEpicNote

public org.gitlab4j.api.models.Note getEpicNote(java.lang.Object groupIdOrPath,
                                                java.lang.Long epicId,
                                                java.lang.Long noteId)
                                         throws GitLabApiException

Get the specified epics's note.

GitLab Endpoint: GET /groups/:id/epics/:epic_id/notes/:note_id

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance; epicId - the epic ID (not the IID!) to get the notes for; noteId - the ID of the Note to get
Returns:: a Note instance for the specified IDs
Throws:: GitLabApiException - if any exception occurs

createEpicNote

public org.gitlab4j.api.models.Note createEpicNote(java.lang.Object groupIdOrPath,
                                                   java.lang.Long epicId,
                                                   java.lang.String body)
                                            throws GitLabApiException

Create a epics's note.

GitLab Endpoint: POST /groups/:id/epics/:epic_id/notes/:note_id

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance @param groupIdOrPath the group ID to create the epics for; epicId - the epic ID (not the IID!) to create the notes for; body - the content of note
Returns:: the created Note instance
Throws:: GitLabApiException - if any exception occurs

createEpicNote

public org.gitlab4j.api.models.Note createEpicNote(java.lang.Object groupIdOrPath,
                                                   java.lang.Long epicId,
                                                   java.lang.String body,
                                                   java.util.Date createdAt)
                                            throws GitLabApiException

Create a epics's note.

GitLab Endpoint: POST /groups/:id/epics/:epic_id/notes/:note_id

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance; epicId - the epic ID (not the IID!) to create the notes for; body - the content of note; createdAt - the created time of note
Returns:: the created Note instance
Throws:: GitLabApiException - if any exception occurs

createEpicNote

public org.gitlab4j.api.models.Note createEpicNote(java.lang.Object groupIdOrPath,
                                                   java.lang.Long epicId,
                                                   java.lang.String body,
                                                   java.util.Date createdAt,
                                                   java.lang.Boolean internal)
                                            throws GitLabApiException

Create a epics's note.

GitLab Endpoint: POST /groups/:id/epics/:epic_id/notes/:note_id

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance; epicId - the epic ID (not the IID!) to create the notes for; body - the content of note; createdAt - the created time of note; internal - whether the note shall be marked 'internal'
Returns:: the created Note instance
Throws:: GitLabApiException - if any exception occurs

updateEpicNote

public org.gitlab4j.api.models.Note updateEpicNote(java.lang.Object groupIdOrPath,
                                                   java.lang.Long epicId,
                                                   java.lang.Long noteId,
                                                   java.lang.String body)
                                            throws GitLabApiException

Update the specified epics's note.

GitLab Endpoint: PUT /groups/:id/epics/:epic_id/notes/:note_id

Parameters:: groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance; epicId - the epic ID (not the IID!) to update the notes for; noteId - the ID of the node to update; body - the update content for the Note
Returns:: the modified Note instance
Throws:: GitLabApiException - if any exception occurs

deleteEpicNote
```
public void deleteEpicNote(java.lang.Object groupIdOrPath,
                           java.lang.Long epicId,
                           java.lang.Long noteId)
                    throws GitLabApiException
```
Delete the specified epics's note.
```
GitLab Endpoint: DELETE /groups/:id/epics/:epic_id/notes/:note_id
```
Parameters:

groupIdOrPath - the group in the form of an Long(ID), String(path), or Group instance

epicId - the epic ID (not the IID!) to delete the notes for

noteId - the ID of the node to delete

Throws:

GitLabApiException - if any exception occurs

Class NotesApi

Nested Class Summary

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

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

Fields inherited from interface org.gitlab4j.models.Constants

Constructor Summary

Method Summary

Methods inherited from class org.gitlab4j.api.AbstractApi

Methods inherited from class java.lang.Object

Constructor Detail

NotesApi

Method Detail

getIssueNotes

getIssueNotes

getIssueNotes

getIssueNotesStream

getIssueNote

createIssueNote

createIssueNote

createIssueNote

updateIssueNote

deleteIssueNote

getMergeRequestNotes

getMergeRequestNotes

getMergeRequestNotes

getMergeRequestNotes

getMergeRequestNotes

getMergeRequestNotesStream

getMergeRequestNotes

getMergeRequestNotesStream

getMergeRequestNote

createMergeRequestNote

updateMergeRequestNote

deleteMergeRequestNote

getEpicNotes

getEpicNotes

getEpicNotes

getEpicNotesStream

getEpicNote

createEpicNote

createEpicNote

createEpicNote

updateEpicNote

deleteEpicNote