ReadJSONStep (Pipeline Utility Steps 2.18.0 API)

java.lang.Object
- hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
- - org.jenkinsci.plugins.workflow.steps.Step
  - - org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep
    - - org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep
      - org.jenkinsci.plugins.pipeline.utility.steps.json.ReadJSONStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>
```
public class ReadJSONStep
extends AbstractFileOrTextStep
```
Reads a JSON file from the workspace.

Author:

Nikolas Falco

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ReadJSONStep.DescriptorImpl
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields
Modifier and Type Field Description

protected boolean returnPojo
- Fields inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep
  text

Constructor Summary

Constructors
Constructor Description

ReadJSONStep()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`getReturnPojo()`	Whether to return a pure Java POJO made of Map and List or the deserialized JSON object (from json-lib).
`void`	`setReturnPojo(boolean returnPojo)`	Whether to return a pure Java POJO made of Map and List or the deserialized JSON object (from json-lib).
`org.jenkinsci.plugins.workflow.steps.StepExecution`	`start(org.jenkinsci.plugins.workflow.steps.StepContext context)`

Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep
getText, setText

Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep
getFile, setFile

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

- Field Detail
  - returnPojo
```
protected boolean returnPojo
```
- Constructor Detail
  - ReadJSONStep
```
@DataBoundConstructor
public ReadJSONStep()
```
- Method Detail
  - 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
  - getReturnPojo
```
public boolean getReturnPojo()
```
    Whether to return a pure Java POJO made of Map and List or the deserialized JSON object (from json-lib). Default is JSON.
    
    Returns:
    
    whether to return a pure Java POJO made of Map and List or the deserialized JSON object (from json-lib). Default is JSON.
  - setReturnPojo
```
@DataBoundSetter
public void setReturnPojo(boolean returnPojo)
```
    Whether to return a pure Java POJO made of Map and List or the deserialized JSON object (from json-lib). Default is JSON.
    
    Parameters:
    
    returnPojo - whether to return a pure Java POJO made of Map and List or the deserialized JSON object (from json-lib). Default is JSON.