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
Iftrue
the action is permitted at this time and the caller is likely allowed to execute it.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 Constructor Description ActionInfo(UiAction.Description d)
-
-
-
Field Detail
-
method
public String method
HTTP method to use with the action. Most actions usePOST
,PUT
orDELETE
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
Iftrue
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.
-
-
Constructor Detail
-
ActionInfo
public ActionInfo(UiAction.Description d)
-
-