Pickaxe.PickaxeConfiguration (foreman: java-api 1.80.0 API)

java.lang.Object
- mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

Enclosing interface:: Pickaxe

public static class Pickaxe.PickaxeConfiguration
extends Object

The pickaxe configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`collectDelay` The collect delay.
`String`	`collectDelayUnits` The collect delay (units).
`int`	`commandCompletionBatchSize` The command completion batch size.
`Integer`	`commandFinishingThreadsOverride` The number of threads to push command updates.
`int`	`commandQueryDelay` The command query delay.
`String`	`commandQueryDelayUnits` The command query delay (units).
`Integer`	`commandThreadsOverride` The number of threads to use for processing commands.
`boolean`	`compressMetrics` Whether or not metrics should be compressed.
`boolean`	`cpowerPlcEnabled` Whether the CPower PLC integration is enabled.
`String`	`cpowerPlcIp` The CPower PLC IP address.
`String`	`cpowerPlcPassword` The CPower PLC password.
`int`	`cpowerPlcPort` The CPower PLC port.
`String`	`cpowerPlcUsername` The CPower PLC username.
`Map<String,String>`	`featureFlags` Pickaxe feature flags.
`int`	`infrastructureCollectDelay` The infrastructure collect delay.
`String`	`infrastructureCollectDelayUnits` The infrastructure collect delay (units).
`Integer`	`infrastructureMetricsBatchSize` The size of each infrastructure metrics batch.
`int`	`infrastructureMetricsPushDelay` The infrastructure metrics push delay.
`String`	`infrastructureMetricsPushDelayUnits` The infrastructure metrics push delay (units).
`Integer`	`infrastructureMetricsThreadsOverride` The number of threads to use for infrastructure metrics sending.
`Integer`	`infrastructureThreadsOverride` The number of threads to use for infrastructure querying.
`String`	`jvmArguments` The JVM arguments.
`Integer`	`metricsBatchSize` The size of each metrics batch.
`int`	`metricsPushDelay` The metrics push delay.
`String`	`metricsPushDelayUnits` The metrics push delay (units).
`Integer`	`metricsRateLimit` The number of IPs to scan per second.
`Integer`	`metricsThreadsOverride` The number of threads to use for metrics sending.
`boolean`	`priorityEnabled` Whether priority power integration is enabled.
`int`	`priorityRtacClientAddress` The priority power RTAC client address.
`String`	`priorityRtacIp` The priority power RTAC IP address.
`int`	`priorityRtacPort` The priority power RTAC port.
`int`	`priorityRtacServerAddress` The priority power RTAC server address.
`Integer`	`rangesRateLimit` The number of IPs to scan per second.
`Integer`	`rangesScannerThreadsOverride` The number of threads to use for scanning (ranges).
`Integer`	`rangesTargetedRateLimit` The number of IPs to scan per second.
`int`	`readSocketTimeout` The read socket timeout.
`String`	`readSocketTimeoutUnits` The read socket timeout (units).
`Integer`	`startStopRateLimit` The number of IPs to scan per second.
`Integer`	`startStopScannerThreadsOverride` The number of threads to use for scanning (start/stop).
`Integer`	`startStopTargetedRateLimit` The number of IPs to scan per second.
`Integer`	`statsThreadsOverride` The number of threads to use for stats querying.
`Integer`	`targetedRangesScannerThreadsOverride` The number of threads to use for scanning (targeted, ranges).
`Integer`	`targetedStartStopScannerThreadsOverride` The number of threads to use for scanning (targeted, start/stop).
`int`	`writeSocketTimeout` The write socket timeout.
`String`	`writeSocketTimeoutUnits` The write socket timeout (units).

Constructor Summary

Constructors
Constructor and Description

PickaxeConfiguration()

Constructors
Constructor and Description
`PickaxeConfiguration()`

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

- Field Detail
  - collectDelay
```
public int collectDelay
```
    The collect delay.
  - collectDelayUnits
```
public String collectDelayUnits
```
    The collect delay (units).
  - commandCompletionBatchSize
```
public int commandCompletionBatchSize
```
    The command completion batch size.
  - commandQueryDelay
```
public int commandQueryDelay
```
    The command query delay.
  - commandQueryDelayUnits
```
public String commandQueryDelayUnits
```
    The command query delay (units).
  - commandThreadsOverride
```
public Integer commandThreadsOverride
```
    The number of threads to use for processing commands.
  - compressMetrics
```
public boolean compressMetrics
```
    Whether or not metrics should be compressed.
  - cpowerPlcEnabled
```
public boolean cpowerPlcEnabled
```
    Whether the CPower PLC integration is enabled.
  - cpowerPlcIp
```
public String cpowerPlcIp
```
    The CPower PLC IP address.
  - cpowerPlcPassword
```
public String cpowerPlcPassword
```
    The CPower PLC password.
  - cpowerPlcPort
```
public int cpowerPlcPort
```
    The CPower PLC port.
  - cpowerPlcUsername
```
public String cpowerPlcUsername
```
    The CPower PLC username.
  - infrastructureCollectDelay
```
public int infrastructureCollectDelay
```
    The infrastructure collect delay.
  - infrastructureCollectDelayUnits
```
public String infrastructureCollectDelayUnits
```
    The infrastructure collect delay (units).
  - infrastructureMetricsBatchSize
```
public Integer infrastructureMetricsBatchSize
```
    The size of each infrastructure metrics batch.
  - infrastructureMetricsPushDelay
```
public int infrastructureMetricsPushDelay
```
    The infrastructure metrics push delay.
  - infrastructureMetricsPushDelayUnits
```
public String infrastructureMetricsPushDelayUnits
```
    The infrastructure metrics push delay (units).
  - infrastructureMetricsThreadsOverride
```
public Integer infrastructureMetricsThreadsOverride
```
    The number of threads to use for infrastructure metrics sending.
  - infrastructureThreadsOverride
```
public Integer infrastructureThreadsOverride
```
    The number of threads to use for infrastructure querying.
  - jvmArguments
```
public String jvmArguments
```
    The JVM arguments.
  - metricsBatchSize
```
public Integer metricsBatchSize
```
    The size of each metrics batch.
  - metricsPushDelay
```
public int metricsPushDelay
```
    The metrics push delay.
  - metricsPushDelayUnits
```
public String metricsPushDelayUnits
```
    The metrics push delay (units).
  - metricsRateLimit
```
public Integer metricsRateLimit
```
    The number of IPs to scan per second.
  - metricsThreadsOverride
```
public Integer metricsThreadsOverride
```
    The number of threads to use for metrics sending.
  - priorityEnabled
```
public boolean priorityEnabled
```
    Whether priority power integration is enabled.
  - priorityRtacClientAddress
```
public int priorityRtacClientAddress
```
    The priority power RTAC client address.
  - priorityRtacIp
```
public String priorityRtacIp
```
    The priority power RTAC IP address.
  - priorityRtacPort
```
public int priorityRtacPort
```
    The priority power RTAC port.
  - priorityRtacServerAddress
```
public int priorityRtacServerAddress
```
    The priority power RTAC server address.
  - rangesRateLimit
```
public Integer rangesRateLimit
```
    The number of IPs to scan per second.
  - rangesScannerThreadsOverride
```
public Integer rangesScannerThreadsOverride
```
    The number of threads to use for scanning (ranges).
  - rangesTargetedRateLimit
```
public Integer rangesTargetedRateLimit
```
    The number of IPs to scan per second.
  - readSocketTimeout
```
public int readSocketTimeout
```
    The read socket timeout.
  - readSocketTimeoutUnits
```
public String readSocketTimeoutUnits
```
    The read socket timeout (units).
  - startStopRateLimit
```
public Integer startStopRateLimit
```
    The number of IPs to scan per second.
  - startStopScannerThreadsOverride
```
public Integer startStopScannerThreadsOverride
```
    The number of threads to use for scanning (start/stop).
  - startStopTargetedRateLimit
```
public Integer startStopTargetedRateLimit
```
    The number of IPs to scan per second.
  - statsThreadsOverride
```
public Integer statsThreadsOverride
```
    The number of threads to use for stats querying.
  - targetedRangesScannerThreadsOverride
```
public Integer targetedRangesScannerThreadsOverride
```
    The number of threads to use for scanning (targeted, ranges).
  - targetedStartStopScannerThreadsOverride
```
public Integer targetedStartStopScannerThreadsOverride
```
    The number of threads to use for scanning (targeted, start/stop).
  - writeSocketTimeout
```
public int writeSocketTimeout
```
    The write socket timeout.
  - writeSocketTimeoutUnits
```
public String writeSocketTimeoutUnits
```
    The write socket timeout (units).
  - featureFlags
```
public Map<String,String> featureFlags
```
    Pickaxe feature flags.
  - commandFinishingThreadsOverride
```
public Integer commandFinishingThreadsOverride
```
    The number of threads to push command updates.
- Constructor Detail
  - PickaxeConfiguration
```
public PickaxeConfiguration()
```

Class Pickaxe.PickaxeConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

collectDelay

collectDelayUnits

commandCompletionBatchSize

commandQueryDelay

commandQueryDelayUnits

commandThreadsOverride

compressMetrics

cpowerPlcEnabled

cpowerPlcIp

cpowerPlcPassword

cpowerPlcPort

cpowerPlcUsername

infrastructureCollectDelay

infrastructureCollectDelayUnits

infrastructureMetricsBatchSize

infrastructureMetricsPushDelay

infrastructureMetricsPushDelayUnits

infrastructureMetricsThreadsOverride

infrastructureThreadsOverride

jvmArguments

metricsBatchSize

metricsPushDelay

metricsPushDelayUnits

metricsRateLimit

metricsThreadsOverride

priorityEnabled

priorityRtacClientAddress

priorityRtacIp

priorityRtacPort

priorityRtacServerAddress

rangesRateLimit

rangesScannerThreadsOverride

rangesTargetedRateLimit

readSocketTimeout

readSocketTimeoutUnits

startStopRateLimit

startStopScannerThreadsOverride

startStopTargetedRateLimit

statsThreadsOverride

targetedRangesScannerThreadsOverride

targetedStartStopScannerThreadsOverride

writeSocketTimeout

writeSocketTimeoutUnits

featureFlags

commandFinishingThreadsOverride

Constructor Detail

PickaxeConfiguration