SchedulerConfig

java.lang.Object
- com.mesosphere.sdk.scheduler.SchedulerConfig

```
public class SchedulerConfig
extends java.lang.Object
```
This class encapsulates global Scheduler settings retrieved from the environment. Presented as a non-static object to simplify scheduler tests, and to make it painfully obvious when global settings are being used in awkward places.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SchedulerConfig.ConfigException
Exception which is thrown when failing to retrieve or parse a given flag value.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SchedulerConfig.ConfigException` Exception which is thrown when failing to retrieve or parse a given flag value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SchedulerConfig`	`fromEnv()` Returns a new `SchedulerConfig` instance which is based off the process environment.
`static SchedulerConfig`	`fromMap(java.util.Map<java.lang.String,java.lang.String> map)` Returns a new `SchedulerConfig` instance which is based off the provided custom environment map.
`java.time.Duration`	`getApiServerInitTimeout()` Returns the configured time to wait for the API server to come up during scheduler initialization.
`int`	`getApiServerPort()` Returns the configured API port, or throws `SchedulerConfig.ConfigException` if the environment lacked the required information.
`java.lang.String`	`getBootstrapURI()`
`TokenProvider`	`getDcosAuthTokenProvider()` Returns a token provider which may be used to retrieve DC/OS JWT auth tokens, or throws an exception if the local environment doesn't provide the needed information (e.g.
`java.lang.String`	`getDcosSpace()`
`java.lang.String`	`getExecutorURI()`
`java.lang.String`	`getJavaHome()`
`java.lang.String`	`getJavaURI()`
`java.lang.String`	`getLibmesosURI()`
`java.lang.String`	`getMesosApiVersion()` Returns the Mesos API version.
`long`	`getPackageBuildTimeMs()` Returns the package build time (unix epoch milliseconds) as advertised in the scheduler environment.
`java.lang.String`	`getPackageName()` Returns the package name as advertised in the scheduler environment.
`java.lang.String`	`getPackageVersion()` Returns the package version as advertised in the scheduler environment.
`java.lang.String`	`getPauseOverrideCmd()` Returns the command to be run when pausing a Task.
`java.lang.String`	`getSecretsNamespace(java.lang.String serviceName)`
`java.lang.String`	`getStatsdHost()` Returns the StatsD host.
`long`	`getStatsDPollIntervalS()` Returns the interval in seconds between StatsD reports.
`int`	`getStatsdPort()` Returns the StatsD port.
`boolean`	`isregionAwarenessEnabled()`
`boolean`	`isSideChannelActive()` Returns whether it appears that side channel auth should be used when creating the SchedulerDriver.
`boolean`	`isStateCacheEnabled()`
`boolean`	`isUninstallEnabled()`

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

- Method Detail
  - fromEnv
```
public static SchedulerConfig fromEnv()
```
    Returns a new SchedulerConfig instance which is based off the process environment.
  - fromMap
```
public static SchedulerConfig fromMap(java.util.Map<java.lang.String,java.lang.String> map)
```
    Returns a new SchedulerConfig instance which is based off the provided custom environment map.
  - getApiServerInitTimeout
```
public java.time.Duration getApiServerInitTimeout()
```
    Returns the configured time to wait for the API server to come up during scheduler initialization.
  - getApiServerPort
```
public int getApiServerPort()
```
    Returns the configured API port, or throws SchedulerConfig.ConfigException if the environment lacked the required information.
  - getExecutorURI
```
public java.lang.String getExecutorURI()
```
  - getBootstrapURI
```
public java.lang.String getBootstrapURI()
```
  - getLibmesosURI
```
public java.lang.String getLibmesosURI()
```
  - getJavaURI
```
public java.lang.String getJavaURI()
```
  - getJavaHome
```
public java.lang.String getJavaHome()
```
  - getDcosSpace
```
public java.lang.String getDcosSpace()
```
  - getSecretsNamespace
```
public java.lang.String getSecretsNamespace(java.lang.String serviceName)
```
  - isStateCacheEnabled
```
public boolean isStateCacheEnabled()
```
  - isUninstallEnabled
```
public boolean isUninstallEnabled()
```
  - isSideChannelActive
```
public boolean isSideChannelActive()
```
    Returns whether it appears that side channel auth should be used when creating the SchedulerDriver. Side channel auth may take the form of Bouncer-based framework authentication or potentially other methods in the future (e.g. Kerberos).
  - getDcosAuthTokenProvider
```
public TokenProvider getDcosAuthTokenProvider()
                                       throws java.io.IOException
```
    Returns a token provider which may be used to retrieve DC/OS JWT auth tokens, or throws an exception if the local environment doesn't provide the needed information (e.g. on a DC/OS Open cluster)
    
    Throws:
    
    java.io.IOException
  - getPackageName
```
public java.lang.String getPackageName()
```
    Returns the package name as advertised in the scheduler environment.
  - getPackageVersion
```
public java.lang.String getPackageVersion()
```
    Returns the package version as advertised in the scheduler environment.
  - getPackageBuildTimeMs
```
public long getPackageBuildTimeMs()
```
    Returns the package build time (unix epoch milliseconds) as advertised in the scheduler environment.
  - getStatsDPollIntervalS
```
public long getStatsDPollIntervalS()
```
    Returns the interval in seconds between StatsD reports.
  - getStatsdHost
```
public java.lang.String getStatsdHost()
```
    Returns the StatsD host.
  - getStatsdPort
```
public int getStatsdPort()
```
    Returns the StatsD port.
  - getMesosApiVersion
```
public java.lang.String getMesosApiVersion()
```
    Returns the Mesos API version.
  - getPauseOverrideCmd
```
public java.lang.String getPauseOverrideCmd()
```
    Returns the command to be run when pausing a Task.
  - isregionAwarenessEnabled
```
public boolean isregionAwarenessEnabled()
```

Class SchedulerConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fromEnv

fromMap

getApiServerInitTimeout

getApiServerPort

getExecutorURI

getBootstrapURI

getLibmesosURI

getJavaURI

getJavaHome

getDcosSpace

getSecretsNamespace

isStateCacheEnabled

isUninstallEnabled

isSideChannelActive

getDcosAuthTokenProvider

getPackageName

getPackageVersion

getPackageBuildTimeMs

getStatsDPollIntervalS

getStatsdHost

getStatsdPort

getMesosApiVersion

getPauseOverrideCmd

isregionAwarenessEnabled