EnterpriseSchedulerFlagsConfigBuilder (Oracle Big Data Spatial and Graph In-memory Analyst Java API Reference v2.4.0 (E62127-06))

java.lang.Object
- oracle.pgx.config.EnterpriseSchedulerFlagsConfigBuilder

@Generated(value={"common/src/templates/ConfigBuilder.stg","common/common.gradle"})
public final class EnterpriseSchedulerFlagsConfigBuilder
extends java.lang.Object

Builder for EnterpriseSchedulerFlagsConfig.

Constructor Summary

Constructors
Constructor and Description
`EnterpriseSchedulerFlagsConfigBuilder()` Constructs an empty EnterpriseSchedulerFlagsConfigBuilder
`EnterpriseSchedulerFlagsConfigBuilder(EnterpriseSchedulerFlagsConfig config)` Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given config
`EnterpriseSchedulerFlagsConfigBuilder(EnterpriseSchedulerFlagsConfigBuilder builder)` Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given builder
`EnterpriseSchedulerFlagsConfigBuilder(java.util.Map<EnterpriseSchedulerFlagsConfig.Field,java.lang.Object> values)` Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given map

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnterpriseSchedulerFlagsConfig`	`build()` Builds the EnterpriseSchedulerFlagsConfig with a `parentPath` of `null`.
`EnterpriseSchedulerFlagsConfig`	`build(java.lang.String parentPath)` Builds the EnterpriseSchedulerFlagsConfig.
`static EnterpriseSchedulerFlagsConfig`	`buildEnterpriseSchedulerFlagsConfig(java.util.function.Consumer<EnterpriseSchedulerFlagsConfigBuilder> builderSetup)` Builds a `EnterpriseSchedulerFlagsConfig` in-place
`EnterpriseSchedulerFlagsConfigBuilder`	`clear()` Clears all values from the builder
`java.util.Map<EnterpriseSchedulerFlagsConfig.Field,java.lang.Object>`	`getValues()`
`EnterpriseSchedulerFlagsConfigBuilder`	`putAll(EnterpriseSchedulerFlagsConfig config)` Puts all values from the given config into this builder
`EnterpriseSchedulerFlagsConfigBuilder`	`putAll(java.util.Map<EnterpriseSchedulerFlagsConfig.Field,java.lang.Object> values)` Puts all values from the given map into this builder.
`EnterpriseSchedulerFlagsConfigBuilder`	`setAlwaysUseJni(boolean alwaysUseJni)` [Internal use only] If `true` always use JNI for work distribution (even when compiled with support for the Graal native interface).
`EnterpriseSchedulerFlagsConfigBuilder`	`setFixThreadsUsedFromMain(boolean fixThreadsUsedFromMain)` [Internal use only] If `true` fix threads used by work spawned by the main thread so that 0..N are used for an N-thread job.
`EnterpriseSchedulerFlagsConfigBuilder`	`setLogToStderr(boolean logToStderr)` If `true` log to stderr.
`EnterpriseSchedulerFlagsConfigBuilder`	`setMarkLoopForProfiling(java.lang.String markLoopForProfiling)` [Internal use only] ID for any additional loop to profile.
`EnterpriseSchedulerFlagsConfigBuilder`	`setOverrideCoresPerSocket(int overrideCoresPerSocket)` [Internal use only] Over-ride the core-to-socket allocation, treating a fixed number of cores as a socket for the purposes of the per-socket combining structures.
`EnterpriseSchedulerFlagsConfigBuilder`	`setOverrideMemoryPlacement(boolean overrideMemoryPlacement)` [Internal use only] Over-ride memory placement tags and use the OS defaults instead.
`EnterpriseSchedulerFlagsConfigBuilder`	`setSelectPerformanceCounters(java.lang.String selectPerformanceCounters)` [Internal use only] Perf counter configuration string.
`EnterpriseSchedulerFlagsConfigBuilder`	`setSelectPerformanceCountersJobRegions(int selectPerformanceCountersJobRegions)` [Internal use only] Issue a region per job automatically.
`EnterpriseSchedulerFlagsConfigBuilder`	`setSelectPerformanceCountersLibrary(int selectPerformanceCountersLibrary)` [Internal use only] Perf counter library.
`EnterpriseSchedulerFlagsConfigBuilder`	`setSelectPerformanceCountersPcmShowCodes(int selectPerformanceCountersPcmShowCodes)` [Internal use only] Show PCM perf counter codes.
`EnterpriseSchedulerFlagsConfigBuilder`	`setSelectPerformanceCountersShowStats(int selectPerformanceCountersShowStats)` [Internal use only] Perf counter per-thread statistics.
`EnterpriseSchedulerFlagsConfigBuilder`	`setSelectRegionPerformanceCounters(java.lang.String selectRegionPerformanceCounters)` [Internal use only] Region perf counter configuration string.
`EnterpriseSchedulerFlagsConfigBuilder`	`setShowAllocations(boolean showAllocations)` If `true` show memory allocation information.
`EnterpriseSchedulerFlagsConfigBuilder`	`setShowDebug(boolean showDebug)` [Internal use only] If `true` enable debug output.
`EnterpriseSchedulerFlagsConfigBuilder`	`setShowDeterministicOutput(boolean showDeterministicOutput)` [Internal use only] If `true` omit thread IDs in debug output (set to true for determinism in regression tests)
`EnterpriseSchedulerFlagsConfigBuilder`	`setShowEnvironment(boolean showEnvironment)` If `true` show version numbers and main environment settings at startup.
`EnterpriseSchedulerFlagsConfigBuilder`	`setShowLogging(boolean showLogging)` If `true` enable summary logging -- this is available even in non-debug builds and includes information such as the machine h/w information obtained at start-up, and per-job / per-loop* information about the workload.
`EnterpriseSchedulerFlagsConfigBuilder`	`setShowProfiling(boolean showProfiling)` If `true` show profiling information.
`EnterpriseSchedulerFlagsConfigBuilder`	`setShowSchedulerState(boolean showSchedulerState)` If `true` dump scheduler state on each update.
`EnterpriseSchedulerFlagsConfigBuilder`	`setShowWarnings(boolean showWarnings)` If `true` enable warnings.
`EnterpriseSchedulerFlagsConfigBuilder`	`setSpinOnExit(boolean spinOnExit)` [Internal use only] If `true` spin after execution, rather than exiting.
`EnterpriseSchedulerFlagsConfigBuilder`	`setUseOpenmpThreadPool(boolean useOpenmpThreadPool)` [Internal use only] If `true`, use OpenMP based thread pool.
`java.io.InputStream`	`toInputStream()`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - EnterpriseSchedulerFlagsConfigBuilder
```
public EnterpriseSchedulerFlagsConfigBuilder()
```
    Constructs an empty EnterpriseSchedulerFlagsConfigBuilder
  - EnterpriseSchedulerFlagsConfigBuilder
```
public EnterpriseSchedulerFlagsConfigBuilder(EnterpriseSchedulerFlagsConfig config)
```
    Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given config
    
    Parameters:
    
    config - the configuration to take the values from
  - EnterpriseSchedulerFlagsConfigBuilder
```
public EnterpriseSchedulerFlagsConfigBuilder(EnterpriseSchedulerFlagsConfigBuilder builder)
```
    Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given builder
    
    Parameters:
    
    builder - the builder to take the values from
  - EnterpriseSchedulerFlagsConfigBuilder
```
public EnterpriseSchedulerFlagsConfigBuilder(java.util.Map<EnterpriseSchedulerFlagsConfig.Field,java.lang.Object> values)
```
    Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given map
    
    Parameters:
    
    values - a map containing configuration values
- Method Detail
  - build
```
public EnterpriseSchedulerFlagsConfig build()
```
    Builds the EnterpriseSchedulerFlagsConfig with a parentPath of null.
    
    Returns:
    
    An instance of EnterpriseSchedulerFlagsConfig
    
    See Also:
    
    build(String)
  - build
```
public EnterpriseSchedulerFlagsConfig build(java.lang.String parentPath)
```
    Builds the EnterpriseSchedulerFlagsConfig.
    
    Parameters:
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    an instance of EnterpriseSchedulerFlagsConfig
  - buildEnterpriseSchedulerFlagsConfig
```
public static EnterpriseSchedulerFlagsConfig buildEnterpriseSchedulerFlagsConfig(java.util.function.Consumer<EnterpriseSchedulerFlagsConfigBuilder> builderSetup)
```
    Builds a EnterpriseSchedulerFlagsConfig in-place
    
    Parameters:
    
    builderSetup - a consumer to setup a newly created EnterpriseSchedulerFlagsConfig
  - clear
```
public EnterpriseSchedulerFlagsConfigBuilder clear()
```
    Clears all values from the builder
  - getValues
```
public java.util.Map<EnterpriseSchedulerFlagsConfig.Field,java.lang.Object> getValues()
```
    Returns:
    
    the raw config values
  - putAll
```
public EnterpriseSchedulerFlagsConfigBuilder putAll(EnterpriseSchedulerFlagsConfig config)
```
    Puts all values from the given config into this builder
    
    Parameters:
    
    config - the config to take the values from
  - putAll
```
public EnterpriseSchedulerFlagsConfigBuilder putAll(java.util.Map<EnterpriseSchedulerFlagsConfig.Field,java.lang.Object> values)
```
    Puts all values from the given map into this builder.
    
    Parameters:
    
    values - the values to put in the builder
  - setAlwaysUseJni
```
public EnterpriseSchedulerFlagsConfigBuilder setAlwaysUseJni(boolean alwaysUseJni)
```
    [Internal use only] If true always use JNI for work distribution (even when compiled with support for the Graal native interface).
  - setFixThreadsUsedFromMain
```
public EnterpriseSchedulerFlagsConfigBuilder setFixThreadsUsedFromMain(boolean fixThreadsUsedFromMain)
```
    [Internal use only] If true fix threads used by work spawned by the main thread so that 0..N are used for an N-thread job. This aids comparison with OpenMP. If this is not set then threads will be chosen dynamically by the runtime system.
  - setLogToStderr
```
public EnterpriseSchedulerFlagsConfigBuilder setLogToStderr(boolean logToStderr)
```
    If true log to stderr. If false log using PGX's default logging facility.
  - setMarkLoopForProfiling
```
public EnterpriseSchedulerFlagsConfigBuilder setMarkLoopForProfiling(java.lang.String markLoopForProfiling)
```
    [Internal use only] ID for any additional loop to profile. If set, the format is name:idx, e.g. "FooBar:1" for the first execution of the FooBar loop, or "XXYZ" for all executions of the XXYZ loop.
  - setOverrideCoresPerSocket
```
public EnterpriseSchedulerFlagsConfigBuilder setOverrideCoresPerSocket(int overrideCoresPerSocket)
```
    [Internal use only] Over-ride the core-to-socket allocation, treating a fixed number of cores as a socket for the purposes of the per-socket combining structures. This is for experimental use on processors like the M7 with core clusters. If 0 use h/w information
  - setOverrideMemoryPlacement
```
public EnterpriseSchedulerFlagsConfigBuilder setOverrideMemoryPlacement(boolean overrideMemoryPlacement)
```
    [Internal use only] Over-ride memory placement tags and use the OS defaults instead. If true use OS defaults, if false use workload tags
  - setSelectPerformanceCounters
```
public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCounters(java.lang.String selectPerformanceCounters)
```
    [Internal use only] Perf counter configuration string.
  - setSelectPerformanceCountersJobRegions
```
public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCountersJobRegions(int selectPerformanceCountersJobRegions)
```
    [Internal use only] Issue a region per job automatically.
  - setSelectPerformanceCountersLibrary
```
public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCountersLibrary(int selectPerformanceCountersLibrary)
```
    [Internal use only] Perf counter library.
  - setSelectPerformanceCountersPcmShowCodes
```
public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCountersPcmShowCodes(int selectPerformanceCountersPcmShowCodes)
```
    [Internal use only] Show PCM perf counter codes.
  - setSelectPerformanceCountersShowStats
```
public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCountersShowStats(int selectPerformanceCountersShowStats)
```
    [Internal use only] Perf counter per-thread statistics.
  - setSelectRegionPerformanceCounters
```
public EnterpriseSchedulerFlagsConfigBuilder setSelectRegionPerformanceCounters(java.lang.String selectRegionPerformanceCounters)
```
    [Internal use only] Region perf counter configuration string.
  - setShowAllocations
```
public EnterpriseSchedulerFlagsConfigBuilder setShowAllocations(boolean showAllocations)
```
    If true show memory allocation information.
  - setShowDebug
```
public EnterpriseSchedulerFlagsConfigBuilder setShowDebug(boolean showDebug)
```
    [Internal use only] If true enable debug output. This is only available in debug builds.
  - setShowDeterministicOutput
```
public EnterpriseSchedulerFlagsConfigBuilder setShowDeterministicOutput(boolean showDeterministicOutput)
```
    [Internal use only] If true omit thread IDs in debug output (set to true for determinism in regression tests)
  - setShowEnvironment
```
public EnterpriseSchedulerFlagsConfigBuilder setShowEnvironment(boolean showEnvironment)
```
    If true show version numbers and main environment settings at startup.
  - setShowLogging
```
public EnterpriseSchedulerFlagsConfigBuilder setShowLogging(boolean showLogging)
```
    If true enable summary logging -- this is available even in non-debug builds and includes information such as the machine h/w information obtained at start-up, and per-job / per-loop* information about the workload.
  - setShowProfiling
```
public EnterpriseSchedulerFlagsConfigBuilder setShowProfiling(boolean showProfiling)
```
    If true show profiling information.
  - setShowSchedulerState
```
public EnterpriseSchedulerFlagsConfigBuilder setShowSchedulerState(boolean showSchedulerState)
```
    If true dump scheduler state on each update.
  - setShowWarnings
```
public EnterpriseSchedulerFlagsConfigBuilder setShowWarnings(boolean showWarnings)
```
    If true enable warnings. These are non-fatal errors -- e.g., if a NUMA-aware allocation cannot be placed on the intended socket.
  - setSpinOnExit
```
public EnterpriseSchedulerFlagsConfigBuilder setSpinOnExit(boolean spinOnExit)
```
    [Internal use only] If true spin after execution, rather than exiting. This provides an opportunity to attach a debugger or to inspect the placement of threads or of memory.
  - setUseOpenmpThreadPool
```
public EnterpriseSchedulerFlagsConfigBuilder setUseOpenmpThreadPool(boolean useOpenmpThreadPool)
```
    [Internal use only] If true, use OpenMP based thread pool. If false use pthreads based thread pool.
  - toInputStream
```
public java.io.InputStream toInputStream()
```
    Returns:
    
    an InputStream representing the config
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class EnterpriseSchedulerFlagsConfigBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnterpriseSchedulerFlagsConfigBuilder

EnterpriseSchedulerFlagsConfigBuilder

EnterpriseSchedulerFlagsConfigBuilder

EnterpriseSchedulerFlagsConfigBuilder

Method Detail

build

build

buildEnterpriseSchedulerFlagsConfig

clear

getValues

putAll

putAll

setAlwaysUseJni

setFixThreadsUsedFromMain

setLogToStderr

setMarkLoopForProfiling

setOverrideCoresPerSocket

setOverrideMemoryPlacement

setSelectPerformanceCounters

setSelectPerformanceCountersJobRegions

setSelectPerformanceCountersLibrary

setSelectPerformanceCountersPcmShowCodes

setSelectPerformanceCountersShowStats

setSelectRegionPerformanceCounters

setShowAllocations

setShowDebug

setShowDeterministicOutput

setShowEnvironment

setShowLogging

setShowProfiling

setShowSchedulerState

setShowWarnings

setSpinOnExit

setUseOpenmpThreadPool

toInputStream

toString