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>.
  • Constructor Details

    • WriteYamlStep

      @DataBoundConstructor public WriteYamlStep()
    • WriteYamlStep

      @Deprecated public WriteYamlStep(Object data)
      Deprecated.
    • WriteYamlStep

      @Deprecated public WriteYamlStep(String file, Object data)
      Deprecated.
  • Method Details

    • 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:
    • 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