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:

hudson.ExtensionPoint, hudson.model.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 and Description
static class	WriteYamlStep.DescriptorImpl
static class	WriteYamlStep.Execution

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
WriteYamlStep(String file, Object data)

Method Summary

Modifier and Type	Method and Description
String	getCharset()
Object	getData() An Object containing data to be saved.
String	getFile() Name of the yaml file to write.
boolean	isOverwrite()
void	setCharset(String charset) The charset encoding to use when writing the file.
void	setOverwrite(boolean overwrite)
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(@Nonnull
                                           String file,
                                           @Nonnull
                                           Object data)

Method Detail

getFile

public String getFile()

Name of the yaml file to write.

Returns:

file name

getData

public Object getData()

An Object containing data to be saved.

Returns:

data to save as yaml

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)

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