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

Class ReviewInput

java.lang.Object

com.google.gerrit.extensions.api.changes.ReviewInput

public class ReviewInput
extends Object

Input passed to POST /changes/[id]/revisions/[id]/review.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReviewInput.CommentInput
static class	ReviewInput.DraftHandling
static class	ReviewInput.RobotCommentInput

Field Summary

Fields

Modifier and Type	Field	Description
List<AttentionSetInput>	addToAttentionSet	Users that should be added to the attention set of this change.
Map<String,List<ReviewInput.CommentInput>>	comments
List<String>	draftIdsToPublish	A list of draft IDs that should be published.
ReviewInput.DraftHandling	drafts	How to process draft comments already in the database that were not also described in this input request.
boolean	ignoreAutomaticAttentionSetRules	Users in the attention set will only be added and removed based on addToAttentionSet and removeFromAttentionSet.
Map<String,Short>	labels
String	message
NotifyHandling	notify	Who to send email notifications to after review is stored.
Map<RecipientType,NotifyInfo>	notifyDetails
boolean	omitDuplicateComments	If true check to make sure that the comments being posted aren't already present.
String	onBehalfOf	Account ID, name, email address or username of another user.
boolean	ready	If true mark the change as ready for review.
List<AttentionSetInput>	removeFromAttentionSet	Users that should be removed from the attention set of this change.
List<ReviewerInput>	reviewers	Reviewers that should be added to this change or removed from it.
Map<String,List<ReviewInput.RobotCommentInput>>	robotComments
String	tag
boolean	workInProgress	If true mark the change as work in progress.

Constructor Summary

Constructors

Constructor	Description
ReviewInput()

Method Summary

Modifier and Type	Method	Description
ReviewInput	addUserToAttentionSet(String user, String reason)
static ReviewInput	approve()
ReviewInput	blockAutomaticAttentionSetRules()
static ReviewInput	create()
static ReviewInput	dislike()
ReviewInput	label(String name)
ReviewInput	label(String name, int value)
ReviewInput	label(String name, short value)
ReviewInput	message(String msg)
static ReviewInput	noScore()
ReviewInput	patchSetLevelComment(String message)
static ReviewInput	recommend()
static ReviewInput	reject()
ReviewInput	removeUserFromAttentionSet(String user, String reason)
ReviewInput	reviewer(String reviewer)
ReviewInput	reviewer(String reviewer, ReviewerState state, boolean confirmed)
ReviewInput	setReady(boolean ready)
ReviewInput	setWorkInProgress(boolean workInProgress)

Methods inherited from class java.lang.Object

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

Field Detail

message

public String message

tag

public String tag

labels

public Map<String,Short> labels

comments

public Map<String,List<ReviewInput.CommentInput>> comments

robotComments

public Map<String,List<ReviewInput.RobotCommentInput>> robotComments

drafts

public ReviewInput.DraftHandling drafts

How to process draft comments already in the database that were not also described in this input request.

If not set, the default is ReviewInput.DraftHandling.KEEP. If onBehalfOf is set, then no other value besides KEEP is allowed.

draftIdsToPublish

public List<String> draftIdsToPublish

A list of draft IDs that should be published.

notify

public NotifyHandling notify

Who to send email notifications to after review is stored.

notifyDetails

public Map<RecipientType,NotifyInfo> notifyDetails

omitDuplicateComments

public boolean omitDuplicateComments

If true check to make sure that the comments being posted aren't already present.

onBehalfOf

public String onBehalfOf

Account ID, name, email address or username of another user. The review will be posted/updated on behalf of this named user instead of the caller. Caller must have the labelAs-$NAME permission granted for each label that appears in labels. This is in addition to the named user also needing to have permission to use the labels.

reviewers

public List<ReviewerInput> reviewers

Reviewers that should be added to this change or removed from it.

workInProgress

public boolean workInProgress

If true mark the change as work in progress. It is an error for both workInProgress and ready to be true.

ready

public boolean ready

If true mark the change as ready for review. It is an error for both workInProgress and ready to be true.

addToAttentionSet

public List<AttentionSetInput> addToAttentionSet

Users that should be added to the attention set of this change.

removeFromAttentionSet

public List<AttentionSetInput> removeFromAttentionSet

Users that should be removed from the attention set of this change.

ignoreAutomaticAttentionSetRules

public boolean ignoreAutomaticAttentionSetRules

Users in the attention set will only be added and removed based on addToAttentionSet and removeFromAttentionSet. Normally, they are also added and removed when some events occur. E.g, adding/removing reviewers, marking a change ready for review or work in progress, and replying on changes.

Constructor Detail

ReviewInput

public ReviewInput()

Method Detail

message

public ReviewInput message(String msg)

patchSetLevelComment

public ReviewInput patchSetLevelComment(String message)

label

public ReviewInput label(String name,
                         short value)

label

public ReviewInput label(String name,
                         int value)

label

public ReviewInput label(String name)

reviewer

public ReviewInput reviewer(String reviewer)

reviewer

public ReviewInput reviewer(String reviewer,
                            ReviewerState state,
                            boolean confirmed)

addUserToAttentionSet

public ReviewInput addUserToAttentionSet(String user,
                                         String reason)

removeUserFromAttentionSet

public ReviewInput removeUserFromAttentionSet(String user,
                                              String reason)

blockAutomaticAttentionSetRules

public ReviewInput blockAutomaticAttentionSetRules()

setWorkInProgress

public ReviewInput setWorkInProgress(boolean workInProgress)

setReady

public ReviewInput setReady(boolean ready)

recommend

public static ReviewInput recommend()

dislike

public static ReviewInput dislike()

noScore

public static ReviewInput noScore()

approve

public static ReviewInput approve()

reject

public static ReviewInput reject()

create

public static ReviewInput create()