Package oracle.pgx.config

Class DataMemoryLimitsConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractDataMemoryLimitsConfig

oracle.pgx.config.DataMemoryLimitsConfig

@Generated("config_generator.py")
public class DataMemoryLimitsConfig
extends AbstractDataMemoryLimitsConfig

PGX Engine Memory Limits Config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataMemoryLimitsConfig.Field	Fields of PGX Engine Memory Limits Config

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static DataMemoryLimitsConfig.Field[]	getConfigFields()
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.lang.Double	getMaxPerSessionDataMemoryRatio()	memory limit for any one session of the PGX engine relative to the user data memory limit
java.lang.String	getMaxPerSessionDataMemorySize()	absolute memory limit for any one session of the PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
java.lang.Double	getMaxPerUserDataMemoryRatio()	memory limit for any one user of the PGX engine relative to the private data memory limit
java.lang.String	getMaxPerUserDataMemorySize()	absolute memory limit for any one user of the PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
java.lang.Double	getMaxTotalDataMemoryRatio()	memory limit across entire PGX engine relative to available system memory
java.lang.String	getMaxTotalDataMemorySize()	absolute memory limit across entire PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
java.lang.Double	getMaxTotalPrivateDataMemoryRatio()	memory limit of private data (includes non-published graphs and PGQL results) relative to total PGX engine memory limit
java.lang.String	getMaxTotalPrivateDataMemorySize()	absolute memory limit of private data (includes non-published graphs and PGQL results), default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
java.lang.Double	getMaxTotalSharedDataMemoryRatio()	memory limit of shared data (includes published graphs and pinned non-referenced graphs) relative to total PGX engine memory limit
java.lang.String	getMaxTotalSharedDataMemorySize()	absolute memory limit of shared data (includes published graphs and pinned non-referenced graphs), default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
boolean	hasDefaultValue(DataMemoryLimitsConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
static DataMemoryLimitsConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static DataMemoryLimitsConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static DataMemoryLimitsConfig	parse(java.util.Properties props, boolean strict)	Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractDataMemoryLimitsConfig

getMaxDataMemoryLimit, isMaxPerSessionDataMemoryRatioSet, isMaxPerUserDataMemoryRatioSet, isMaxTotalDataMemoryRatioSet, isMaxTotalPrivateDataMemoryRatioSet, isMaxTotalSharedDataMemoryRatioSet, validate, validateMaxDataMemoryLimit

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

parse

public static DataMemoryLimitsConfig parse(java.io.InputStream is,
                                           boolean strict,
                                           java.lang.String parentPath)
                                    throws java.io.IOException

Parses an input stream.

Parameters:

is - the input stream

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

parse

public static DataMemoryLimitsConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                           boolean strict,
                                           java.lang.String parentPath)

Parses a raw key/value mapping.

Parameters:

raw - the raw key/value mapping to parse

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

parse

public static DataMemoryLimitsConfig parse(java.util.Properties props,
                                           boolean strict)

Parses a properties file.

Parameters:

props - the properties to parse

strict - if true, parses in strict mode

Returns:

the parsed graph config

getConfigFields

public static DataMemoryLimitsConfig.Field[] getConfigFields()

getValues

public java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Specified by:

getValues in class AbstractConfig

Returns:

the parsed values

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

hasDefaultValue

public boolean hasDefaultValue(DataMemoryLimitsConfig.Field field)

Checks for default value.

Specified by:

hasDefaultValue in class AbstractDataMemoryLimitsConfig

Parameters:

field - the field

Returns:

true, if value for given field is the default value

getValuesWithoutDefaults

public java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

getLeftoverValues

public java.util.Map<java.lang.String,java.lang.Object> getLeftoverValues()

Gets the values that do not belong to any field.

Returns:

the values that do not belong to any field

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean hideSensitiveData)

getMaxTotalDataMemorySize

public java.lang.String getMaxTotalDataMemorySize()

absolute memory limit across entire PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units

Specified by:

getMaxTotalDataMemorySize in class AbstractDataMemoryLimitsConfig

getMaxTotalDataMemoryRatio

public java.lang.Double getMaxTotalDataMemoryRatio()

memory limit across entire PGX engine relative to available system memory

Specified by:

getMaxTotalDataMemoryRatio in class AbstractDataMemoryLimitsConfig

getMaxTotalPrivateDataMemorySize

public java.lang.String getMaxTotalPrivateDataMemorySize()

absolute memory limit of private data (includes non-published graphs and PGQL results), default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units

Specified by:

getMaxTotalPrivateDataMemorySize in class AbstractDataMemoryLimitsConfig

getMaxTotalPrivateDataMemoryRatio

public java.lang.Double getMaxTotalPrivateDataMemoryRatio()

memory limit of private data (includes non-published graphs and PGQL results) relative to total PGX engine memory limit

Specified by:

getMaxTotalPrivateDataMemoryRatio in class AbstractDataMemoryLimitsConfig

getMaxTotalSharedDataMemorySize

public java.lang.String getMaxTotalSharedDataMemorySize()

absolute memory limit of shared data (includes published graphs and pinned non-referenced graphs), default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units

Specified by:

getMaxTotalSharedDataMemorySize in class AbstractDataMemoryLimitsConfig

getMaxTotalSharedDataMemoryRatio

public java.lang.Double getMaxTotalSharedDataMemoryRatio()

memory limit of shared data (includes published graphs and pinned non-referenced graphs) relative to total PGX engine memory limit

Specified by:

getMaxTotalSharedDataMemoryRatio in class AbstractDataMemoryLimitsConfig

getMaxPerUserDataMemorySize

public java.lang.String getMaxPerUserDataMemorySize()

absolute memory limit for any one user of the PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units

Specified by:

getMaxPerUserDataMemorySize in class AbstractDataMemoryLimitsConfig

getMaxPerUserDataMemoryRatio

public java.lang.Double getMaxPerUserDataMemoryRatio()

memory limit for any one user of the PGX engine relative to the private data memory limit

Specified by:

getMaxPerUserDataMemoryRatio in class AbstractDataMemoryLimitsConfig

getMaxPerSessionDataMemorySize

public java.lang.String getMaxPerSessionDataMemorySize()

absolute memory limit for any one session of the PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units

Specified by:

getMaxPerSessionDataMemorySize in class AbstractDataMemoryLimitsConfig

getMaxPerSessionDataMemoryRatio

public java.lang.Double getMaxPerSessionDataMemoryRatio()

memory limit for any one session of the PGX engine relative to the user data memory limit

Specified by:

getMaxPerSessionDataMemoryRatio in class AbstractDataMemoryLimitsConfig

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object