Package com.google.gerrit.extensions.api.changes

Interface RevisionApi

All Known Implementing Classes:

RevisionApi.NotImplemented

public interface RevisionApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RevisionApi.MergeListRequest
static class	RevisionApi.NotImplemented	A default implementation which allows source compatibility when adding new methods to the interface.

Method Summary

Modifier and Type	Method	Description
Map<String,ActionInfo>	actions()
EditInfo	applyFix(ApplyProvidedFixInput applyProvidedFixInput)	Applies fix similar to applyFix method.
EditInfo	applyFix(String fixId)	Applies the indicated fix by creating a new change edit or integrating the fix with the existing change edit.
boolean	canRebase()
ChangeApi	cherryPick(CherryPickInput in)
ChangeInfo	cherryPickAsInfo(CherryPickInput in)
CommentApi	comment(String id)
Map<String,List<CommentInfo>>	comments()
List<CommentInfo>	commentsAsList()
CommitInfo	commit(boolean addLinks)
DraftApi	createDraft(DraftInput in)
String	description()
void	description(String description)
DraftApi	draft(String id)
Map<String,List<CommentInfo>>	drafts()
List<CommentInfo>	draftsAsList()
String	etag()
FileApi	file(String path)
default Map<String,FileInfo>	files()
Map<String,FileInfo>	files(int parentNum)
Map<String,FileInfo>	files(String base)
BinaryResult	getArchive(ArchiveFormat format)	Retrieves the revision as an archive.
Map<String,DiffInfo>	getFixPreview(ApplyProvidedFixInput applyProvidedFixInput)
Map<String,DiffInfo>	getFixPreview(String fixId)
RevisionApi.MergeListRequest	getMergeList()
MergeableInfo	mergeable()
MergeableInfo	mergeableOtherBranches()
BinaryResult	patch()	Returns patch of revision.
BinaryResult	patch(String path)
Map<String,List<CommentInfo>>	portedComments()
Map<String,List<CommentInfo>>	portedDrafts()
List<String>	queryFiles(String query)
default ChangeApi	rebase()
ChangeApi	rebase(RebaseInput in)
ChangeInfo	rebaseAsInfo(RebaseInput in)
RelatedChangesInfo	related()
RelatedChangesInfo	related(EnumSet<GetRelatedOption> listOptions)
ReviewResult	review(ReviewInput in)
Set<String>	reviewed()
RevisionReviewerApi	reviewer(String id)
RobotCommentApi	robotComment(String id)
Map<String,List<RobotCommentInfo>>	robotComments()
List<RobotCommentInfo>	robotCommentsAsList()
void	setReviewed(String path, boolean reviewed)
default ChangeInfo	submit()
ChangeInfo	submit(SubmitInput in)
SubmitType	submitType()
TestSubmitRuleInfo	testSubmitRule(TestSubmitRuleInput in)
SubmitType	testSubmitType(TestSubmitRuleInput in)
com.google.common.collect.ListMultimap<String,ApprovalInfo>	votes()	Returns votes on the revision.

Method Details

description

String description()
            throws RestApiException

Throws:

RestApiException

description

void description(String description)
          throws RestApiException

Throws:

RestApiException

review

@CanIgnoreReturnValue
ReviewResult review(ReviewInput in)
             throws RestApiException

Throws:

RestApiException

submit

@CanIgnoreReturnValue
default ChangeInfo submit()
                   throws RestApiException

Throws:

RestApiException

submit

@CanIgnoreReturnValue
ChangeInfo submit(SubmitInput in)
           throws RestApiException

Throws:

RestApiException

cherryPick

@CanIgnoreReturnValue
ChangeApi cherryPick(CherryPickInput in)
              throws RestApiException

Throws:

RestApiException

cherryPickAsInfo

ChangeInfo cherryPickAsInfo(CherryPickInput in)
                     throws RestApiException

Throws:

RestApiException

rebase

@CanIgnoreReturnValue
default ChangeApi rebase()
                  throws RestApiException

Throws:

RestApiException

rebase

@CanIgnoreReturnValue
ChangeApi rebase(RebaseInput in)
          throws RestApiException

Throws:

RestApiException

rebaseAsInfo

ChangeInfo rebaseAsInfo(RebaseInput in)
                 throws RestApiException

Throws:

RestApiException

canRebase

boolean canRebase()
           throws RestApiException

Throws:

RestApiException

reviewer

RevisionReviewerApi reviewer(String id)
                      throws RestApiException

Throws:

RestApiException

setReviewed

void setReviewed(String path,
 boolean reviewed)
          throws RestApiException

Throws:

RestApiException

reviewed

Set<String> reviewed()
              throws RestApiException

Throws:

RestApiException

files

default Map<String,FileInfo> files()
                            throws RestApiException

Throws:

RestApiException

files

Map<String,FileInfo> files(String base)
                    throws RestApiException

Throws:

RestApiException

files

Map<String,FileInfo> files(int parentNum)
                    throws RestApiException

Throws:

RestApiException

queryFiles

List<String> queryFiles(String query)
                 throws RestApiException

Throws:

RestApiException

file

FileApi file(String path)

commit

CommitInfo commit(boolean addLinks)
           throws RestApiException

Throws:

RestApiException

mergeable

MergeableInfo mergeable()
                 throws RestApiException

Throws:

RestApiException

mergeableOtherBranches

MergeableInfo mergeableOtherBranches()
                              throws RestApiException

Throws:

RestApiException

comments

Map<String,List<CommentInfo>> comments()
                                throws RestApiException

Throws:

RestApiException

robotComments

Map<String,List<RobotCommentInfo>> robotComments()
                                          throws RestApiException

Throws:

RestApiException

drafts

Map<String,List<CommentInfo>> drafts()
                              throws RestApiException

Throws:

RestApiException

commentsAsList

List<CommentInfo> commentsAsList()
                          throws RestApiException

Throws:

RestApiException

draftsAsList

List<CommentInfo> draftsAsList()
                        throws RestApiException

Throws:

RestApiException

robotCommentsAsList

List<RobotCommentInfo> robotCommentsAsList()
                                    throws RestApiException

Throws:

RestApiException

portedComments

Map<String,List<CommentInfo>> portedComments()
                                      throws RestApiException

Throws:

RestApiException

portedDrafts

Map<String,List<CommentInfo>> portedDrafts()
                                    throws RestApiException

Throws:

RestApiException

applyFix

@CanIgnoreReturnValue
EditInfo applyFix(String fixId)
           throws RestApiException

Applies the indicated fix by creating a new change edit or integrating the fix with the existing change edit. If no change edit exists before this call, the fix must refer to the current patch set. If a change edit exists, the fix must refer to the patch set on which the change edit is based.

Parameters:

fixId - the ID of the fix which should be applied

Throws:

RestApiException - if the fix couldn't be applied

applyFix

@CanIgnoreReturnValue
EditInfo applyFix(ApplyProvidedFixInput applyProvidedFixInput)
           throws RestApiException

Applies fix similar to applyFix method. Instead of using a fix stored in the server, this applies the fix provided in ApplyProvidedFixInput

Parameters:

applyProvidedFixInput - The fix(es) to apply to a new change edit.

Throws:

RestApiException - if the fix couldn't be applied.

getFixPreview

Map<String,DiffInfo> getFixPreview(String fixId)
                            throws RestApiException

Throws:

RestApiException

getFixPreview

Map<String,DiffInfo> getFixPreview(ApplyProvidedFixInput applyProvidedFixInput)
                            throws RestApiException

Throws:

RestApiException

createDraft

@CanIgnoreReturnValue
DraftApi createDraft(DraftInput in)
              throws RestApiException

Throws:

RestApiException

draft

DraftApi draft(String id)
        throws RestApiException

Throws:

RestApiException

comment

CommentApi comment(String id)
            throws RestApiException

Throws:

RestApiException

robotComment

RobotCommentApi robotComment(String id)
                      throws RestApiException

Throws:

RestApiException

etag

String etag()
     throws RestApiException

Throws:

RestApiException

patch

BinaryResult patch()
            throws RestApiException

Returns patch of revision.

Throws:

RestApiException

patch

BinaryResult patch(String path)
            throws RestApiException

Throws:

RestApiException

actions

Map<String,ActionInfo> actions()
                        throws RestApiException

Throws:

RestApiException

submitType

SubmitType submitType()
               throws RestApiException

Throws:

RestApiException

testSubmitType

SubmitType testSubmitType(TestSubmitRuleInput in)
                   throws RestApiException

Throws:

RestApiException

testSubmitRule

TestSubmitRuleInfo testSubmitRule(TestSubmitRuleInput in)
                           throws RestApiException

Throws:

RestApiException

getMergeList

RevisionApi.MergeListRequest getMergeList()
                                   throws RestApiException

Throws:

RestApiException

related

RelatedChangesInfo related()
                    throws RestApiException

Throws:

RestApiException

related

RelatedChangesInfo related(EnumSet<GetRelatedOption> listOptions)
                    throws RestApiException

Throws:

RestApiException

votes

com.google.common.collect.ListMultimap<String,ApprovalInfo> votes()
                                                           throws RestApiException

Returns votes on the revision.

Throws:

RestApiException

getArchive

BinaryResult getArchive(ArchiveFormat format)
                 throws RestApiException

Retrieves the revision as an archive.

Parameters:

format - the format of the archive

Returns:

the archive as BinaryResult

Throws:

RestApiException