SetGerritReviewStep (Gerrit Trigger 2.42.0 API)

java.lang.Object
- hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
- - org.jenkinsci.plugins.workflow.steps.Step
  - - com.sonyericsson.hudson.plugins.gerrit.trigger.workflow.SetGerritReviewStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>
```
public class SetGerritReviewStep
extends org.jenkinsci.plugins.workflow.steps.Step
```
Allows altering the Gerrit review posted at the end of build during the build.

Author:

Teemu Murtola <teemu.murtola@gmail.com>

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SetGerritReviewStep.DescriptorImpl`	Adds the step as a workflow extension.
`static class`	`SetGerritReviewStep.Execution`	Executes the SetGerritReviewStep.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors
Constructor Description

SetGerritReviewStep()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCustomUrl()`	Gets the custom URL for a step.
`String`	`getUnsuccessfulMessage()`	Gets the unsuccessful message for a step.
`void`	`setCustomUrl(String customUrl)`	Sets a custom URL to post for a build.
`void`	`setUnsuccessfulMessage(String unsuccessfulMessage)`	Sets additional information to post for a failed build.
`org.jenkinsci.plugins.workflow.steps.StepExecution`	`start(org.jenkinsci.plugins.workflow.steps.StepContext context)`

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step
getDescriptor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SetGerritReviewStep
```
@DataBoundConstructor
public SetGerritReviewStep()
```
    Constructor. There are no mandatory parameters to the step.
- Method Detail
  - getCustomUrl
```
@CheckForNull
public String getCustomUrl()
```
    Gets the custom URL for a step.
    
    Returns:
    
    the URL.
  - setCustomUrl
```
@DataBoundSetter
public void setCustomUrl(String customUrl)
```
    Sets a custom URL to post for a build.
    
    Parameters:
    
    customUrl - the URL to post.
  - getUnsuccessfulMessage
```
@CheckForNull
public String getUnsuccessfulMessage()
```
    Gets the unsuccessful message for a step.
    
    Returns:
    
    the message.
  - setUnsuccessfulMessage
```
@DataBoundSetter
public void setUnsuccessfulMessage(String unsuccessfulMessage)
```
    Sets additional information to post for a failed build.
    
    Parameters:
    
    unsuccessfulMessage - Additional information to post for a failed build.
  - start
```
public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception
```
    Specified by:
    
    start in class org.jenkinsci.plugins.workflow.steps.Step
    
    Throws:
    
    Exception