Package org.jenkinsci.plugins.pipeline.utility.steps.conf

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 Classes

Modifier and Type	Class	Description
static class	WriteYamlStep.DescriptorImpl
static class	WriteYamlStep.Execution

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
WriteYamlStep()
WriteYamlStep(Object data)	Deprecated.
WriteYamlStep(String file, Object data)	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getCharset()
Object	getData()	An Object containing data to be saved.
Collection	getDatas()	A Collection containing datas to be saved.
String	getFile()	Name of the yaml file to write.
boolean	isOverwrite()
boolean	isReturnText()
void	setCharset(String charset)	The charset encoding to use when writing the file.
void	setData(Object data)	An Object containing data to be saved.
void	setDatas(Collection datas)	A Collection containing datas to be saved.
void	setFile(String file)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WriteYamlStep

@DataBoundConstructor
public WriteYamlStep()

WriteYamlStep

@Deprecated
public WriteYamlStep(Object data)

Deprecated.

WriteYamlStep

@Deprecated
public WriteYamlStep(String file,
                     Object data)

Deprecated.

Method Detail

getFile

public String getFile()

Name of the yaml file to write.

Returns:

file name

setFile

@DataBoundSetter
public void setFile(String file)

getData

public Object getData()

An Object containing data to be saved.

Returns:

data to save as yaml

setData

@DataBoundSetter
public void setData(Object data)

An Object containing data to be saved.

Parameters:

data - data to save as yaml

getDatas

public Collection getDatas()

A Collection containing datas to be saved.

Returns:

datas to save as several yaml documents

setDatas

@DataBoundSetter
public void setDatas(Collection datas)

A Collection containing datas to be saved.

Parameters:

datas - to save as several yaml documents

getCharset

public String getCharset()

setCharset

@DataBoundSetter
public void setCharset(String charset)

The charset encoding to use when writing the file. Defaults to UTF-8.

Parameters:

charset - the charset

See Also:

Charset, Charset.forName(String)

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 class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception