ScanSettings (AppSpider Plugin 1.0.17 API)

java.lang.Object
- com.rapid7.appspider.ScanSettings

```
public class ScanSettings
extends Object
```
Storage class for scan settings provided by Jenkins

Constructor Summary

Constructors
Constructor	Description
`ScanSettings(String configName, String reportName, Boolean enableScan, Boolean generateReport, String scanConfigName, String scanConfigUrl, String scanConfigEngineGroupName)`	Constructs a DTO style container object storing scan settings from Jenkins

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getConfigName()`
`boolean`	`getEnableScan()`
`boolean`	`getGenerateReport()`
`String`	`getNewConfigName()`
`String`	`getNewConfigUrl()`
`String`	`getReportName()`
`String`	`getScanConfigEngineGroupName()`
`int`	`getStatusPollTime()`
`ScanSettings`	`withConfigName(String configName)`
`ScanSettings`	`withEmptyConfigValues()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ScanSettings
```
public ScanSettings(String configName,
                    String reportName,
                    Boolean enableScan,
                    Boolean generateReport,
                    String scanConfigName,
                    String scanConfigUrl,
                    String scanConfigEngineGroupName)
```
  Constructs a DTO style container object storing scan settings from Jenkins
  
  Parameters:
  
  configName - name of the scan config to run
  
  reportName - name of the report
  
  enableScan - when to enable a new scan
  
  generateReport - whether to generate a report at the end of the scan
  
  scanConfigName - name of the scan configuration to run (as known to AppSpider Enterprise)
  
  scanConfigUrl - URL of the scan configuration
  
  scanConfigEngineGroupName - name of the engine group to run the scan under

Method Detail

getConfigName
```
public String getConfigName()
```

withConfigName

public ScanSettings withConfigName(String configName)

getReportName
```
public String getReportName()
```

getEnableScan
```
public boolean getEnableScan()
```

getGenerateReport
```
public boolean getGenerateReport()
```

getNewConfigName
```
public String getNewConfigName()
```

getScanConfigEngineGroupName

public String getScanConfigEngineGroupName()

getNewConfigUrl
```
public String getNewConfigUrl()
```

getStatusPollTime
```
public int getStatusPollTime()
```

withEmptyConfigValues

public ScanSettings withEmptyConfigValues()