ReadFileStep (Pipeline: Basic Steps 994.vd57e3ca_46d24 API)

java.lang.Object
- hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
- - org.jenkinsci.plugins.workflow.steps.Step
  - - org.jenkinsci.plugins.workflow.steps.ReadFileStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>
```
public final class ReadFileStep
extends org.jenkinsci.plugins.workflow.steps.Step
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ReadFileStep.DescriptorImpl

static class ReadFileStep.Execution
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors
Constructor Description

ReadFileStep(String file)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getEncoding()`
`String`	`getFile()`
`void`	`setEncoding(String encoding)`	Set the encoding to be used when reading the file.
`org.jenkinsci.plugins.workflow.steps.StepExecution`	`start(org.jenkinsci.plugins.workflow.steps.StepContext context)`

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
  - ReadFileStep
```
@DataBoundConstructor
public ReadFileStep(String file)
```
- Method Detail
  - getFile
```
public String getFile()
```
  - getEncoding
```
public String getEncoding()
```
  - setEncoding
```
@DataBoundSetter
public void setEncoding(String encoding)
```
    Set the encoding to be used when reading the file. If the specified value is null or whitespace-only, then the platform default encoding will be used. Binary resources can be loaded as a Base64-encoded string by specifying Base64 as the encoding.
  - 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