Class WriteJSONStep
java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
org.jenkinsci.plugins.pipeline.utility.steps.json.WriteJSONStep
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
public class WriteJSONStep
extends org.jenkinsci.plugins.workflow.steps.Step
Writes a
JSON
object to file in the current working directory.- Author:
- Nikolas Falco
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Constructor Summary
ConstructorsConstructorDescriptionWriteJSONStep
(Object json) WriteJSONStep
(String file, Object json) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptiongetFile()
Returns the name of the file to write.getJson()
Return the JSON object to save.int
Return the number of spaces used to prettify the JSON dump.boolean
void
void
setReturnText
(boolean returnText) 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
-
Constructor Details
-
WriteJSONStep
-
WriteJSONStep
Deprecated.
-
-
Method Details
-
getFile
Returns the name of the file to write.- Returns:
- the file name
-
setFile
-
getJson
Return the JSON object to save.If it is not a
JSON
object,JSONObject.fromObject(Object)
will be used in a first step.- Returns:
- an object
-
getPretty
public int getPretty()Return the number of spaces used to prettify the JSON dump.- Returns:
- a int
-
isReturnText
public boolean isReturnText() -
setReturnText
@DataBoundSetter public void setReturnText(boolean returnText) -
start
public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context) throws Exception - Specified by:
start
in classorg.jenkinsci.plugins.workflow.steps.Step
- Throws:
Exception
-