com.google.gerrit.extensions.api.changes

Class ReviewInput

java.lang.Object

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

public class ReviewInput
extends java.lang.Object

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.util.List<ReviewInput.CommentInput>>	comments
ReviewInput.DraftHandling	drafts How to process draft comments already in the database that were not also described in this input request.
java.util.Map<java.lang.String,java.lang.Short>	labels
java.lang.String	message
NotifyHandling	notify Who to send email notifications to after review is stored.
java.util.Map<RecipientType,NotifyInfo>	notifyDetails
boolean	omitDuplicateComments If true check to make sure that the comments being posted aren't already present.
java.lang.String	onBehalfOf Account ID, name, email address or username of another user.
java.util.List<AddReviewerInput>	reviewers Reviewers that should be added to this change.
java.util.Map<java.lang.String,java.util.List<ReviewInput.RobotCommentInput>>	robotComments
boolean	strictLabels If true require all labels to be within the user's permitted ranges based on access controls, attempting to use a label not granted to the user will fail the entire modify operation early.
java.lang.String	tag

Constructor Summary

Constructors

Constructor and Description
ReviewInput()

Method Summary

Modifier and Type	Method and Description
static ReviewInput	approve()
static ReviewInput	dislike()
ReviewInput	label(java.lang.String name)
ReviewInput	label(java.lang.String name, int value)
ReviewInput	label(java.lang.String name, short value)
ReviewInput	message(java.lang.String msg)
static ReviewInput	noScore()
static ReviewInput	recommend()
static ReviewInput	reject()
ReviewInput	reviewer(java.lang.String reviewer)
ReviewInput	reviewer(java.lang.String reviewer, ReviewerState state, boolean confirmed)

Methods inherited from class java.lang.Object

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

Field Detail

message

public java.lang.String message

tag

public java.lang.String tag

labels

public java.util.Map<java.lang.String,java.lang.Short> labels

comments

public java.util.Map<java.lang.String,java.util.List<ReviewInput.CommentInput>> comments

robotComments

public java.util.Map<java.lang.String,java.util.List<ReviewInput.RobotCommentInput>> robotComments

strictLabels

public boolean strictLabels

If true require all labels to be within the user's permitted ranges based on access controls, attempting to use a label not granted to the user will fail the entire modify operation early. If false the operation will execute anyway, but the proposed labels given by the user will be modified to be the "best" value allowed by the access controls, or ignored if the label does not exist.

drafts

public ReviewInput.DraftHandling drafts

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

Defaults to DELETE, unless onBehalfOf is set, in which case it defaults to KEEP and any other value is disallowed.

notify

public NotifyHandling notify

Who to send email notifications to after review is stored.

notifyDetails

public java.util.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 java.lang.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.

strictLabels impacts how labels is processed for the named user, not the caller.

reviewers

public java.util.List<AddReviewerInput> reviewers

Reviewers that should be added to this change.

Constructor Detail

ReviewInput

public ReviewInput()

Method Detail

message

public ReviewInput message(java.lang.String msg)

label

public ReviewInput label(java.lang.String name,
                         short value)

label

public ReviewInput label(java.lang.String name,
                         int value)

label

public ReviewInput label(java.lang.String name)

reviewer

public ReviewInput reviewer(java.lang.String reviewer)

reviewer

public ReviewInput reviewer(java.lang.String reviewer,
                            ReviewerState state,
                            boolean confirmed)

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()