Class WriteYamlStep
java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
org.jenkinsci.plugins.pipeline.utility.steps.conf.WriteYamlStep
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
public class WriteYamlStep
extends org.jenkinsci.plugins.workflow.steps.Step
Writes a yaml file from the workspace.
- Author:
- Javier DELGADO <witokondoria@gmail.com>.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Constructor Summary
ConstructorsConstructorDescriptionWriteYamlStep
(Object data) Deprecated.WriteYamlStep
(String file, Object data) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptiongetData()
An Object containing data to be saved.getDatas()
A Collection containing datas to be saved.getFile()
Name of the yaml file to write.boolean
boolean
void
setCharset
(String charset) The charset encoding to use when writing the file.void
An Object containing data to be saved.void
setDatas
(Collection datas) A Collection containing datas to be saved.void
void
setOverwrite
(boolean overwrite) 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
-
WriteYamlStep
@DataBoundConstructor public WriteYamlStep() -
WriteYamlStep
Deprecated. -
WriteYamlStep
Deprecated.
-
-
Method Details
-
getFile
Name of the yaml file to write.- Returns:
- file name
-
setFile
-
getData
An Object containing data to be saved.- Returns:
- data to save as yaml
-
setData
An Object containing data to be saved.- Parameters:
data
- data to save as yaml
-
getDatas
A Collection containing datas to be saved.- Returns:
- datas to save as several yaml documents
-
setDatas
A Collection containing datas to be saved.- Parameters:
datas
- to save as several yaml documents
-
getCharset
-
setCharset
The charset encoding to use when writing the file. Defaults to UTF-8.- Parameters:
charset
- the charset- See Also:
-
isOverwrite
public boolean isOverwrite() -
setOverwrite
@DataBoundSetter public void setOverwrite(boolean overwrite) -
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
-