EnterpriseSchedulerFlagsConfig.Field (Oracle Spatial and Graph In-memory Analyst Java API 18c, E87806-01)

java.lang.Object
- java.lang.Enum<EnterpriseSchedulerFlagsConfig.Field>
- - oracle.pgx.config.EnterpriseSchedulerFlagsConfig.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EnterpriseSchedulerFlagsConfig.Field>, ConfigField

Enclosing class:

EnterpriseSchedulerFlagsConfig
```
public static enum EnterpriseSchedulerFlagsConfig.Field
extends java.lang.Enum<EnterpriseSchedulerFlagsConfig.Field>
implements ConfigField
```
Fields of Enterprise Scheduler flags

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALWAYS_USE_JNI` [Internal use only] If `true` always use JNI for work distribution (even when compiled with support for the Graal native interface).
`FIX_THREADS_USED_FROM_MAIN` [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.
`LOG_TO_STDERR` If `true` log to stderr.
`MARK_LOOP_FOR_PROFILING` [Internal use only] ID for any additional loop to profile.
`OVERRIDE_CORES_PER_SOCKET` [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.
`OVERRIDE_MEMORY_PLACEMENT` [Internal use only] Over-ride memory placement tags and use the OS defaults instead.
`SELECT_PERFORMANCE_COUNTERS` [Internal use only] Perf counter configuration string.
`SELECT_PERFORMANCE_COUNTERS_JOB_REGIONS` [Internal use only] Issue a region per job automatically.
`SELECT_PERFORMANCE_COUNTERS_LIBRARY` [Internal use only] Perf counter library.
`SELECT_PERFORMANCE_COUNTERS_PCM_SHOW_CODES` [Internal use only] Show PCM perf counter codes.
`SELECT_PERFORMANCE_COUNTERS_SHOW_STATS` [Internal use only] Perf counter per-thread statistics.
`SELECT_REGION_PERFORMANCE_COUNTERS` [Internal use only] Region perf counter configuration string.
`SHOW_ALLOCATIONS` If `true` show memory allocation information.
`SHOW_DEBUG` [Internal use only] If `true` enable debug output.
`SHOW_DETERMINISTIC_OUTPUT` [Internal use only] If `true` omit thread IDs in debug output (set to true for determinism in regression tests)
`SHOW_ENVIRONMENT` If `true` show version numbers and main environment settings at startup.
`SHOW_LOGGING` 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.
`SHOW_PROFILING` If `true` show profiling information.
`SHOW_SCHEDULER_STATE` If `true` dump scheduler state on each update.
`SHOW_WARNINGS` If `true` enable warnings.
`SPIN_ON_EXIT` [Internal use only] If `true` spin after execution, rather than exiting.
`USE_OPENMP_THREAD_POOL` [Internal use only] If `true`, use OpenMP based thread pool.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getDefaultVal()` Gets the default value of this field.
`java.util.List<java.lang.String>`	`getKeyAliases()` Gets the key aliases of this field which are also recognized during parsing.
`java.util.List<java.lang.String>`	`getSingletonListKeyAliases()` Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
`java.lang.Class<?>`	`getType()` Gets the type of this field.
`boolean`	`isArray()` Checks if this field is an array.
`boolean`	`isPath()` Checks if this field is a path.
`boolean`	`isRequired()` Checks if this field is required.
`boolean`	`isSensitive()` Checks if this field holds a sensitive data.
`java.lang.String`	`toKey()` Get the key of this field, which is how this field is represented in serialized form.
`java.lang.String`	`toString()`
`static EnterpriseSchedulerFlagsConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EnterpriseSchedulerFlagsConfig.Field[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

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

Methods inherited from interface oracle.pgx.config.ConfigField
isEnum, isPrimitive

- Enum Constant Detail
  - ALWAYS_USE_JNI
```
public static final EnterpriseSchedulerFlagsConfig.Field ALWAYS_USE_JNI
```
    [Internal use only] If true always use JNI for work distribution (even when compiled with support for the Graal native interface).
  - FIX_THREADS_USED_FROM_MAIN
```
public static final EnterpriseSchedulerFlagsConfig.Field FIX_THREADS_USED_FROM_MAIN
```
    [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.
  - LOG_TO_STDERR
```
public static final EnterpriseSchedulerFlagsConfig.Field LOG_TO_STDERR
```
    If true log to stderr. If false log using PGX's default logging facility.
  - MARK_LOOP_FOR_PROFILING
```
public static final EnterpriseSchedulerFlagsConfig.Field MARK_LOOP_FOR_PROFILING
```
    [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.
  - OVERRIDE_CORES_PER_SOCKET
```
public static final EnterpriseSchedulerFlagsConfig.Field OVERRIDE_CORES_PER_SOCKET
```
    [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
  - OVERRIDE_MEMORY_PLACEMENT
```
public static final EnterpriseSchedulerFlagsConfig.Field OVERRIDE_MEMORY_PLACEMENT
```
    [Internal use only] Over-ride memory placement tags and use the OS defaults instead. If true use OS defaults, if false use workload tags
  - SELECT_PERFORMANCE_COUNTERS
```
public static final EnterpriseSchedulerFlagsConfig.Field SELECT_PERFORMANCE_COUNTERS
```
    [Internal use only] Perf counter configuration string.
  - SELECT_PERFORMANCE_COUNTERS_JOB_REGIONS
```
public static final EnterpriseSchedulerFlagsConfig.Field SELECT_PERFORMANCE_COUNTERS_JOB_REGIONS
```
    [Internal use only] Issue a region per job automatically.
  - SELECT_PERFORMANCE_COUNTERS_LIBRARY
```
public static final EnterpriseSchedulerFlagsConfig.Field SELECT_PERFORMANCE_COUNTERS_LIBRARY
```
    [Internal use only] Perf counter library.
  - SELECT_PERFORMANCE_COUNTERS_PCM_SHOW_CODES
```
public static final EnterpriseSchedulerFlagsConfig.Field SELECT_PERFORMANCE_COUNTERS_PCM_SHOW_CODES
```
    [Internal use only] Show PCM perf counter codes.
  - SELECT_PERFORMANCE_COUNTERS_SHOW_STATS
```
public static final EnterpriseSchedulerFlagsConfig.Field SELECT_PERFORMANCE_COUNTERS_SHOW_STATS
```
    [Internal use only] Perf counter per-thread statistics.
  - SELECT_REGION_PERFORMANCE_COUNTERS
```
public static final EnterpriseSchedulerFlagsConfig.Field SELECT_REGION_PERFORMANCE_COUNTERS
```
    [Internal use only] Region perf counter configuration string.
  - SHOW_ALLOCATIONS
```
public static final EnterpriseSchedulerFlagsConfig.Field SHOW_ALLOCATIONS
```
    If true show memory allocation information.
  - SHOW_DEBUG
```
public static final EnterpriseSchedulerFlagsConfig.Field SHOW_DEBUG
```
    [Internal use only] If true enable debug output. This is only available in debug builds.
  - SHOW_DETERMINISTIC_OUTPUT
```
public static final EnterpriseSchedulerFlagsConfig.Field SHOW_DETERMINISTIC_OUTPUT
```
    [Internal use only] If true omit thread IDs in debug output (set to true for determinism in regression tests)
  - SHOW_ENVIRONMENT
```
public static final EnterpriseSchedulerFlagsConfig.Field SHOW_ENVIRONMENT
```
    If true show version numbers and main environment settings at startup.
  - SHOW_LOGGING
```
public static final EnterpriseSchedulerFlagsConfig.Field SHOW_LOGGING
```
    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.
  - SHOW_PROFILING
```
public static final EnterpriseSchedulerFlagsConfig.Field SHOW_PROFILING
```
    If true show profiling information.
  - SHOW_SCHEDULER_STATE
```
public static final EnterpriseSchedulerFlagsConfig.Field SHOW_SCHEDULER_STATE
```
    If true dump scheduler state on each update.
  - SHOW_WARNINGS
```
public static final EnterpriseSchedulerFlagsConfig.Field SHOW_WARNINGS
```
    If true enable warnings. These are non-fatal errors -- e.g., if a NUMA-aware allocation cannot be placed on the intended socket.
  - SPIN_ON_EXIT
```
public static final EnterpriseSchedulerFlagsConfig.Field SPIN_ON_EXIT
```
    [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.
  - USE_OPENMP_THREAD_POOL
```
public static final EnterpriseSchedulerFlagsConfig.Field USE_OPENMP_THREAD_POOL
```
    [Internal use only] If true, use OpenMP based thread pool. If false use pthreads based thread pool.
- Method Detail
  - getDefaultVal
```
public java.lang.Object getDefaultVal()
```
    Description copied from interface: ConfigField
    
    Gets the default value of this field.
    
    Specified by:
    
    getDefaultVal in interface ConfigField
    
    Returns:
    
    the default value
  - getKeyAliases
```
public java.util.List<java.lang.String> getKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which are also recognized during parsing.
    
    Specified by:
    
    getKeyAliases in interface ConfigField
    
    Returns:
    
    the key aliases
  - getSingletonListKeyAliases
```
public java.util.List<java.lang.String> getSingletonListKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
    
    Specified by:
    
    getSingletonListKeyAliases in interface ConfigField
    
    Returns:
    
    the singleton list key aliases
  - getType
```
public java.lang.Class<?> getType()
```
    Description copied from interface: ConfigField
    
    Gets the type of this field.
    
    Specified by:
    
    getType in interface ConfigField
    
    Returns:
    
    the type
  - isArray
```
public boolean isArray()
```
    Description copied from interface: ConfigField
    
    Checks if this field is an array.
    
    Specified by:
    
    isArray in interface ConfigField
    
    Returns:
    
    true, if array
  - isPath
```
public boolean isPath()
```
    Description copied from interface: ConfigField
    
    Checks if this field is a path.
    
    Specified by:
    
    isPath in interface ConfigField
    
    Returns:
    
    true, if path
  - isRequired
```
public boolean isRequired()
```
    Description copied from interface: ConfigField
    
    Checks if this field is required.
    
    Specified by:
    
    isRequired in interface ConfigField
    
    Returns:
    
    true, if required
  - isSensitive
```
public boolean isSensitive()
```
    Description copied from interface: ConfigField
    
    Checks if this field holds a sensitive data.
    
    Specified by:
    
    isSensitive in interface ConfigField
    
    Returns:
    
    true, if use for sensitive data
  - toKey
```
public java.lang.String toKey()
```
    Description copied from interface: ConfigField
    
    Get the key of this field, which is how this field is represented in serialized form.
    
    Specified by:
    
    toKey in interface ConfigField
    
    Returns:
    
    the key.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<EnterpriseSchedulerFlagsConfig.Field>
  - valueOf
```
public static EnterpriseSchedulerFlagsConfig.Field valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - values
```
public static EnterpriseSchedulerFlagsConfig.Field[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (EnterpriseSchedulerFlagsConfig.Field c : EnterpriseSchedulerFlagsConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum EnterpriseSchedulerFlagsConfig.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.ConfigField

Enum Constant Detail

ALWAYS_USE_JNI

FIX_THREADS_USED_FROM_MAIN

LOG_TO_STDERR

MARK_LOOP_FOR_PROFILING

OVERRIDE_CORES_PER_SOCKET

OVERRIDE_MEMORY_PLACEMENT

SELECT_PERFORMANCE_COUNTERS

SELECT_PERFORMANCE_COUNTERS_JOB_REGIONS

SELECT_PERFORMANCE_COUNTERS_LIBRARY

SELECT_PERFORMANCE_COUNTERS_PCM_SHOW_CODES

SELECT_PERFORMANCE_COUNTERS_SHOW_STATS

SELECT_REGION_PERFORMANCE_COUNTERS

SHOW_ALLOCATIONS

SHOW_DEBUG

SHOW_DETERMINISTIC_OUTPUT

SHOW_ENVIRONMENT

SHOW_LOGGING

SHOW_PROFILING

SHOW_SCHEDULER_STATE

SHOW_WARNINGS

SPIN_ON_EXIT

USE_OPENMP_THREAD_POOL

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isPath

isRequired

isSensitive

toKey

toString

valueOf

values