Class AbstractFileCompressStep
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.AbstractFileCompressStep
- 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.Ant style pattern of files to exclude from the archive.getGlob()
Ant style pattern of files to include in the archive.boolean
If the archive file should be archived as an artifact of the current build.boolean
The defaultExcludes of ant java pattern.boolean
If the archive file should be overwritten in case of already existing a file with the same name.void
setArchive
(boolean archive) If the archive file should be archived as an artifact of the current build.void
setDefaultExcludes
(boolean defaultExcludes) The defaultExcludes of ant java pattern.void
The relative path of the base directory to create the archive from.void
setExclude
(String exclude) Ant style pattern of files to exclude in the archive.void
Ant style pattern of files to include in the archive.void
setOverwrite
(boolean overwrite) If the archive file should be overwritten in case of already existing a file with the same name.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
-
AbstractFileCompressStep
public AbstractFileCompressStep()
-
-
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 include in the archive. Leave empty to include all files and directories.- Returns:
- the include pattern
-
setGlob
Ant style pattern of files to include in the archive. Leave empty to include all files and directories.- Parameters:
glob
- the include pattern
-
getExclude
Ant style pattern of files to exclude from the archive.- Returns:
- the exclude pattern
-
setExclude
Ant style pattern of files to exclude in the archive.- Parameters:
exclude
- the exclude pattern
-
isArchive
public boolean isArchive()If the archive file should be archived as an artifact of the current build. The file will still be kept in the workspace after archiving.- Returns:
- if it should be archived or not
-
setArchive
@DataBoundSetter public void setArchive(boolean archive) If the archive file should be archived as an artifact of the current build. The file will still be kept in the workspace after archiving.- Parameters:
archive
- if it should be archived or not
-
isOverwrite
public boolean isOverwrite()If the archive file should be overwritten in case of already existing a file with the same name.- Returns:
- if the file should be overwritten or not in case of existing.
-
setOverwrite
@DataBoundSetter public void setOverwrite(boolean overwrite) If the archive file should be overwritten in case of already existing a file with the same name.- Parameters:
overwrite
- if the file should be overwritten or not in case of existing.
-
isDefaultExcludes
public boolean isDefaultExcludes()The defaultExcludes of ant java pattern.- Returns:
- the defaultExcludes boolean value
-
setDefaultExcludes
@DataBoundSetter public void setDefaultExcludes(boolean defaultExcludes) The defaultExcludes of ant java pattern.- Parameters:
defaultExcludes
- the defaultExcludes boolean value
-