TarStep (Pipeline Utility Steps 2.18.0 API)

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
      - org.jenkinsci.plugins.pipeline.utility.steps.tar.TarStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>
```
public class TarStep
extends AbstractFileCompressStep
```
Creates a tar file.

Author:

Alexander Falkenstern <Alexander.Falkenstern@gmail.com>.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TarStep.DescriptorImpl
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors
Constructor Description

TarStep(String file)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isCompress()`	If the tar file should be compressed with gzip.
`void`	`setCompress(boolean compress)`	If the tar file should be compressed with gzip.
`org.jenkinsci.plugins.workflow.steps.StepExecution`	`start(org.jenkinsci.plugins.workflow.steps.StepContext context)`

Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileCompressStep
getDir, getExclude, getGlob, isArchive, isDefaultExcludes, isOverwrite, setArchive, setDefaultExcludes, setDir, setExclude, setGlob, setOverwrite

Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep
getFile, setFile

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

TarStep

@DataBoundConstructor
public TarStep(String file)
        throws Descriptor.FormException

Throws:: Descriptor.FormException

Method Detail
- isCompress
```
public boolean isCompress()
```
  If the tar file should be compressed with gzip.
  
  Returns:
  
  if tar should be compressed with gzip
- setCompress
```
@DataBoundSetter
public void setCompress(boolean compress)
```
  If the tar file should be compressed with gzip.
  
  Parameters:
  
  compress - if it should be compressed with gz or not
- 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