java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
All Implemented Interfaces:
ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class ReadYamlStep extends AbstractFileOrTextStep
Reads a yaml file from the workspace.
Author:
Philippe GRANET <philippe.granet@gmail.com>.
  • Field Details

    • LIBRARY_DEFAULT_CODE_POINT_LIMIT

      public static final int LIBRARY_DEFAULT_CODE_POINT_LIMIT
    • MAX_CODE_POINT_LIMIT_PROPERTY

      public static final String MAX_CODE_POINT_LIMIT_PROPERTY
    • DEFAULT_CODE_POINT_LIMIT_PROPERTY

      public static final String DEFAULT_CODE_POINT_LIMIT_PROPERTY
    • HARDCODED_CEILING_MAX_ALIASES_FOR_COLLECTIONS

      public static final int HARDCODED_CEILING_MAX_ALIASES_FOR_COLLECTIONS
      See Also:
    • LIBRARY_DEFAULT_MAX_ALIASES_FOR_COLLECTIONS

      public static final int LIBRARY_DEFAULT_MAX_ALIASES_FOR_COLLECTIONS
    • MAX_MAX_ALIASES_PROPERTY

      public static final String MAX_MAX_ALIASES_PROPERTY
    • DEFAULT_MAX_ALIASES_PROPERTY

      public static final String DEFAULT_MAX_ALIASES_PROPERTY
  • Constructor Details

    • ReadYamlStep

      @DataBoundConstructor public ReadYamlStep()
  • Method Details

    • getMaxCodePointLimit

      public static int getMaxCodePointLimit()
    • setDefaultCodePointLimit

      public static int setDefaultCodePointLimit(int defaultCodePointLimit)
      Setter with an added check to ensure the default does not exceed the max value.
      Parameters:
      defaultCodePointLimit - the default value to set.
      Returns:
      the actual value set after checking the max allowed.
    • getDefaultCodePointLimit

      public static int getDefaultCodePointLimit()
    • setMaxMaxAliasesForCollections

      public static int setMaxMaxAliasesForCollections(int maxMaxAliasesForCollections)
      Setter with an added check to ensure the default does not exceed the hardcoded max value. TODO: decide if we want to add a message here before failing back.
      Parameters:
      maxMaxAliasesForCollections - maximum allowed aliases to be set.
      Returns:
      the resulting value after checking the ceiling.
    • getMaxMaxAliasesForCollections

      public static int getMaxMaxAliasesForCollections()
    • setDefaultMaxAliasesForCollections

      public static int setDefaultMaxAliasesForCollections(int defaultMaxAliasesForCollections)
      Setter with an added check to ensure the default does not exceed the max value.
      Parameters:
      defaultMaxAliasesForCollections - the default value to set.
      Returns:
      the actual value set after checking the max allowed.
    • getDefaultMaxAliasesForCollections

      public static int getDefaultMaxAliasesForCollections()
    • getCodePointLimit

      public int getCodePointLimit()
    • setCodePointLimit

      @DataBoundSetter public void setCodePointLimit(int codePointLimit)
    • getMaxAliasesForCollections

      public int getMaxAliasesForCollections()
    • setMaxAliasesForCollections

      @DataBoundSetter public void setMaxAliasesForCollections(int maxAliasesForCollections)
    • 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