Package com.google.gerrit.extensions.common

Class ActionInfo

java.lang.Object

com.google.gerrit.extensions.common.ActionInfo

public class ActionInfo
extends Object

Representation of an action in the REST API.

This class determines the JSON format of actions in the REST API.

An action describes a REST API call the client can make to manipulate a resource. These are frequently implemented by plugins and may be discovered at runtime.

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	enabled	If true the action is permitted at this time and the caller is likely allowed to execute it.
List<String>	enabledOptions	Optional list of enabled options.
String	label	Short title to display to a user describing the action.
String	method	HTTP method to use with the action.
String	title	Longer text to display describing the action.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActionInfo()
	ActionInfo(UiAction.Description d)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

method

public String method

HTTP method to use with the action. Most actions use POST, PUT or DELETE to cause state changes.

label

public String label

Short title to display to a user describing the action. In the Gerrit web interface the label is used as the text on the button that is presented in the UI.

title

public String title

Longer text to display describing the action. In a web UI this should be the title attribute of the element, displaying when the user hovers the mouse.

enabled

public Boolean enabled

If true the action is permitted at this time and the caller is likely allowed to execute it. This may change if state is updated at the server or permissions are modified.

enabledOptions

public List<String> enabledOptions

Optional list of enabled options.

For the rebase REST view the following options are supported:

• rebase: Present if the user can rebase the change. This is the case for the change owner and users with the Submit or Rebase permission if they have the Push permission.
• rebase_on_behalf_of: Present if the user can rebase the change on behalf of the uploader. This is the case for the change owner and users with the Submit or Rebase permission.

For all other REST views no options are returned.

Constructor Detail

ActionInfo

public ActionInfo(UiAction.Description d)

ActionInfo

protected ActionInfo()

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object