Class AbstractFileDecompressStep
java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep
org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileDecompressStep
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
-
Nested Class Summary
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetDir()
The relative path of the base directory to create the archive from.getGlob()
Ant style pattern of files to extract from the archive.boolean
isQuiet()
Suppress the verbose output that logs every single file that is dealt with.boolean
isTest()
Test the integrity of the archive instead of extracting it.void
The relative path of the base directory to create the archive from.void
Ant style pattern of files to extract from the archive.void
setQuiet
(boolean quiet) Suppress the verbose output that logs every single file that is dealt with.void
setTest
(boolean test) Test the integrity of the archive instead of extracting it.Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep
getFile, setFile
Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step
getDescriptor, start
-
Constructor Details
-
AbstractFileDecompressStep
public AbstractFileDecompressStep()
-
-
Method Details
-
getDir
The relative path of the base directory to create the archive from. Leave empty to create from the current working directory.- Returns:
- the dir
-
setDir
The relative path of the base directory to create the archive from. Leave empty to create from the current working directory.- Parameters:
dir
- the dir
-
getGlob
Ant style pattern of files to extract from the archive. Leave empty to include all files and directories.- Returns:
- the include pattern
-
setGlob
Ant style pattern of files to extract from the archive. Leave empty to include all files and directories.- Parameters:
glob
- the include pattern
-
isTest
public boolean isTest()Test the integrity of the archive instead of extracting it. When this parameter is enabled, all other parameters (except forAbstractFileStep.getFile()
) will be ignored. The step will returntrue
orfalse
depending on the result instead of throwing an exception.- Returns:
- if the archive should just be tested or not
-
setTest
@DataBoundSetter public void setTest(boolean test) Test the integrity of the archive instead of extracting it. When this parameter is enabled, all other parameters (except forAbstractFileStep.getFile()
) will be ignored. The step will returntrue
orfalse
depending on the result instead of throwing an exception.- Parameters:
test
- if the archive should just be tested or not
-
isQuiet
public boolean isQuiet()Suppress the verbose output that logs every single file that is dealt with.- Returns:
- if verbose logging should be suppressed
-
setQuiet
@DataBoundSetter public void setQuiet(boolean quiet) Suppress the verbose output that logs every single file that is dealt with.- Parameters:
quiet
- if verbose logging should be suppressed
-